Merchant settlement created

This event occurs when a settlement process is finished with success.

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

|
id required

Title: The merchant settlement identifier
Description: This field identifies the merchant transaction created.
Type: integer
Example:
123456789

merchant_id required

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

settlement_date required

Title: The date of settlement
Description: This field identifies the date when the settlement occurred.
Type: string
Format: date
Example:
2006-01-02

gross_amount required

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

net_amount required

Title: The net amount of the settlement
Description: This field identifies the settlement net amount.
Type: number
Example:
100.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:
007400

settlement_type required

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

payment_type required

Title: The payment type.
Description: This field identifies the type related to the payment.
Type: string
Example:
ACCOUNT

payment_info required

Title: The payment info.
Description: Additional information related to the payment.
Type: object
Example:

{
    "account_id": 187191962
}
fees

Title: The fees.
Description: This field identifies the fees related to the settlement.
Type: array

title required

Title: The title.
Description: This field identifies the title related to the fees.
Type: string
Example:
mdr

amount required

Title: The amount.
Description: This field identifies the amount related to the fees.
Type: number
Example:
0.1

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Merchant settlement created",
    "description": "This event occurs when a settlement process is finished with success.",
    "required": [
        "id",
        "merchant_id",
        "settlement_date",
        "gross_amount",
        "net_amount",
        "processing_code",
        "settlement_type",
        "payment_type",
        "payment_info"
    ],
    "properties": {
        "id": {
            "$id": "#/properties/id",
            "type": "integer",
            "title": "The merchant settlement identifier",
            "description": "This field identifies the merchant transaction created.",
            "examples": [
                123456789
            ]
        },
        "merchant_id": {
            "$id": "#/properties/merchant_id",
            "type": "integer",
            "title": "The merchant identifier",
            "description": "This field identifies the merchant related to transaction.",
            "examples": [
                123456789
            ]
        },
        "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": [
                "2006-01-02"
            ]
        },
        "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
            ]
        },
        "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
            ]
        },
        "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": [
                "007400"
            ]
        },
        "settlement_type": {
            "$id": "#/properties/settlement_type",
            "type": "string",
            "title": "The settlement type.",
            "description": "This field identifies the type related to the settlement.",
            "examples": [
                "MERCHANT_TRANSACTIONS"
            ]
        },
        "payment_type": {
            "$id": "#/properties/payment_type",
            "type": "string",
            "title": "The payment type.",
            "description": "This field identifies the type related to the payment.",
            "examples": [
                "ACCOUNT"
            ]
        },
        "payment_info": {
            "$id": "#/properties/payment_info",
            "type": "object",
            "title": "The payment info.",
            "description": "Additional information related to the payment.",
            "examples": [
                {
                    "account_id": 187191962
                }
            ]
        },
        "fees": {
            "$id": "#/properties/fees",
            "type": "array",
            "title": "The fees.",
            "description": "This field identifies the fees related to the settlement.",
            "items": {
                "type": "object",
                "title": "The fee",
                "description": "This field identifies the fee related to the settlement.",
                "required": [
                    "title",
                    "amount"
                ],
                "properties": {
                    "title": {
                        "$id": "#/properties/fees/items/title",
                        "type": "string",
                        "title": "The title.",
                        "description": "This field identifies the title related to the fees.",
                        "examples": [
                            "mdr"
                        ]
                    },
                    "amount": {
                        "$id": "#/properties/fees/items/amount",
                        "type": "number",
                        "title": "The amount.",
                        "description": "This field identifies the amount related to the fees.",
                        "examples": [
                            0.1
                        ]
                    }
                }
            }
        }
    }
}
{
    "id": 123456789,
    "merchant_id": 123456789,
    "settlement_date": "2006-01-02",
    "gross_amount": 100.0,
    "net_amount": 100.0,
    "processing_code": "007400",
    "settlement_type": "MERCHANT_TRANSACTIONS",
    "payment_type": "ACCOUNT",
    "payment_info": {
        "account_id": 187191962
    },
    "fees": {
        "title": "mdr",
        "amount": 0.1
    }
}