Current scheduled payment status displayed

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

account_id required

Title: Account identifier
Type: integer
Example:
5501

id required

Title: Scheduled execution identifier
Type: string
Min length: 1
Max length: 36
Example:
626d0a8e-b68a-4557-9002-dd24abb8508b

status required

Title: Current schedule status
Description:
It only accepts the following values:
ACTIVE: When the shceduled payment is active.
COMPLETED: When the scheduled payment has completed.
FAILED: When the scheduled payment has failed.
ABORTED: When the scheduled payment has aborted execution.
Type: string
Min length: 1
Max length: 20
Example:
ACTIVE

external_account_id

Title: External Account identifier
Description: A custom account ID string that uniquely identifies the account within your organization.
Type: string or null
Example:
UK1-2e6e6817-92b2-4ab8-a23e-a50e2f0e6d90

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Current scheduled payment status displayed",
    "required": [
        "account_id",
        "id",
        "status"
    ],
    "properties": {
        "account_id": {
            "title": "Account identifier",
            "type": "integer",
            "minimum": 1,
            "maximum": 99999999999,
            "examples": [
                5501
            ]
        },
        "id": {
            "title": "Scheduled execution identifier",
            "type": "string",
            "minLength": 1,
            "maxLength": 36,
            "examples": [
                "626d0a8e-b68a-4557-9002-dd24abb8508b"
            ]
        },
        "status": {
            "title": "Current schedule status",
            "description": "\n\nIt only accepts the following values:\n\n<span style='font-weight:bold'>ACTIVE:</span> When the shceduled payment is active.\n\n<span style='font-weight:bold'>COMPLETED:</span> When the scheduled payment has completed.\n\n<span style='font-weight:bold'>FAILED:</span> When the scheduled payment has failed.\n\n<span style='font-weight:bold'>ABORTED:</span> When the scheduled payment has aborted execution.\n\n",
            "type": "string",
            "minLength": 1,
            "maxLength": 20,
            "examples": [
                "ACTIVE"
            ]
        },
        "external_account_id": {
            "type": [
                "string",
                "null"
            ],
            "title": "External Account identifier",
            "description": "A custom account ID string that uniquely identifies the account within your organization.",
            "examples": [
                "UK1-2e6e6817-92b2-4ab8-a23e-a50e2f0e6d90"
            ]
        }
    }
}

{
    "account_id": 5501,
    "id": "626d0a8e-b68a-4557-9002-dd24abb8508b",
    "status": "ACTIVE",
    "external_account_id": "UK1-2e6e6817-92b2-4ab8-a23e-a50e2f0e6d90"
}

Updated 9 days ago