Float payment lifecycle status changed

Type: object
Domain: corporate
Event: float_payment_status_change
Version: 1

tracking_id required

Title: A unique identifier for the float payment
Type: string
Min length: 1
Max length: 75
Example:
UK1-eb75c472-a213-41a7-a96e-ac0156b832f0

external_account_id required

Title: External Account identifier
Type: string
Min length: 1
Max length: 60
Example:
UK1-2e6e6817-92b2-4ab8-a23e-a50e2f0e6d90

status required

Title: Current float payment status
Description:
It only accepts the following values:
CREATED: When the float payment request is created.
UNSETTLED: When the float payment has unsettled values.
SETTLED:When the float payment has been paid in full.
FAILED: When an error occurred.
Type: string
Must be one of the following:
CREATED
UNSETTLED
SETTLED
FAILED
Example:
UNSETTLED

settlement_date required

Title: Settlement Date
Description: Corresponds to the cycle closing date relative to the payment date
Type: string
Format: date
Example:
2022-12-20

division_id

Title: Division unique identifier
Description: Division ID generated by Pismo.
Type: string
Max length: 36
Example:
57af8b5b-d843-48ef-b536-2c601962504b

division_code

Title: Division Code
Description: Unique code that identifies the division within your organization.
Type: string
Max length: 36
Example:
division-code-123

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Float payment lifecycle status changed",
    "required": [
        "tracking_id",
        "external_account_id",
        "status",
        "settlement_date"
    ],
    "properties": {
        "tracking_id": {
            "title": "A unique identifier for the float payment",
            "type": "string",
            "minLength": 1,
            "maxLength": 75,
            "examples": [
                "UK1-eb75c472-a213-41a7-a96e-ac0156b832f0"
            ]
        },
        "external_account_id": {
            "title": "External Account identifier",
            "type": "string",
            "minLength": 1,
            "maxLength": 60,
            "examples": [
                "UK1-2e6e6817-92b2-4ab8-a23e-a50e2f0e6d90"
            ]
        },
        "status": {
            "title": "Current float payment status",
            "description": "\n\nIt only accepts the following values:\n\n<span style='font-weight:bold'>CREATED:</span> When the float payment request is created.\n\n<span style='font-weight:bold'>UNSETTLED:</span> When the float payment has unsettled values.\n\n<span style='font-weight:bold'>SETTLED:</span>When the float payment has been paid in full.\n\n<span style='font-weight:bold'>FAILED:</span> When an error occurred.\n\n",
            "type": "string",
            "enum": [
                "CREATED",
                "UNSETTLED",
                "SETTLED",
                "FAILED"
            ],
            "examples": [
                "UNSETTLED"
            ]
        },
        "settlement_date": {
            "type": "string",
            "title": "Settlement Date",
            "description": "Corresponds to the cycle closing date relative to the payment date",
            "format": "date",
            "examples": [
                "2022-12-20"
            ]
        },
        "division_id": {
            "type": "string",
            "title": "Division unique identifier",
            "description": "Division ID generated by Pismo.",
            "maxLength": 36,
            "examples": [
                "57af8b5b-d843-48ef-b536-2c601962504b"
            ]
        },
        "division_code": {
            "type": "string",
            "title": "Division Code",
            "description": "Unique code that identifies the division within your organization.",
            "maxLength": 36,
            "examples": [
                "division-code-123"
            ]
        }
    }
}

{
    "tracking_id": "UK1-eb75c472-a213-41a7-a96e-ac0156b832f0",
    "external_account_id": "UK1-2e6e6817-92b2-4ab8-a23e-a50e2f0e6d90",
    "status": "UNSETTLED",
    "settlement_date": "2022-12-20",
    "division_id": "57af8b5b-d843-48ef-b536-2c601962504b",
    "division_code": "division-code-123"
}

Updated 13 days ago