Future dated payment lifecycle event

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

|
tracking_id required

Title: A unique 50-character ID that identifies the future dated payment
Type: string
Min length: 1
Max length: 50
Example:
UK1-eb75c472-a213-41a7-a96e-ac0156b832f0

status required

Title: Current future dated payment status
Description:
It only accepts the following values:
CREATED: When the future dated payment request is created.
UNSETTLED: When the future dated payment has unsettled values.
SETTLED:When the future dated payment has been paid in full.
CANCELED: When the future dated payment was canceled.
EXPIRED: When the future dated payment has expired.
Type: string
Min length: 1
Max length: 20
Must be one of the following:
CREATED
UNSETTLED
SETTLED
CANCELED
EXPIRED
Example:
CREATED

account_id required

Title: Account identifier
Type: integer
Example:
5501

external_account_id

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

division_id

Title: Division unique identifier
Description: Division unique identifier generated by Pismo
Type: string
Min length: 1
Max length: 36
Example:
7c6138a3-0daa-4a49-aa76-fa03294146b2

division_code

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

processing_code

Title: Processing code
Description: Processing code used for posting the future dated payment.
Type: string
Min length: 1
Max length: 6
Example:
220041
220043

amount required

Title: Future dated payment amount
Type: number
Example:
10.1
100.2
30

uncleared_funds required

Title: The balance of the future dated payment funds that was posted on the account pending for clearance or confirmation.
Type: number
Example:
10.1
100.2
30

currency required

Title: A three-letter alphabetic code in ISO 4217 standard that corresponds to the currency used in the earmark transaction
Type: string
Min length: 1
Max length: 3
Example:
USD
GBP
BRL

payment_datetime

Title: Payment timestamp in RFC 3339 date/time format
Type: string or null
Format: date-time
Example:
2023-05-20T20:29:59.026Z

settlement_date

Title: Settlement date
Description: The future dated payment settlement date.
Type: string
Format: date
Example:
2023-02-06

internal_operation

Title: Contains the transaction data executed internally
Type: object or null

type required

Title: Type of the internal operation
Description:
It only accepts the following values:
INITIAL_PAYMENT: When future dated payment initial payment request is executed.
SETTLEMENT: When the future dated payment is paid partially/fully.
CANCELATION: When the future dated payment was canceled.
EXPIRATION: When the future dated payment has expired.
Type: string
Min length: 1
Max length: 20
Must be one of the following:
INITIAL_PAYMENT
SETTLEMENT
CANCELATION
EXPIRATION
Example:
INITIAL_PAYMENT

tracking_id required

Title: Tracking number that identifies the transaction
Type: string
Min length: 1
Max length: 50
Example:
b12eeb8b-bd3c-4367-b1d6-484c2e4d530a

amount required

Title: Internal operation amount
Type: number
Example:
10.1
100.2
30

business_date

Title: Business date
Description: The internal operation business date.
Type: string
Format: date
Example:
2023-02-06

created_at required

Title: RFC 3339 date/time for the operation creation
Type: string
Format: date-time
Example:
2023-05-20T20:29:59.026Z

metadata

Title: Key-value fields that contain relevant data your organization needs to store at Pismo
Type: object or null
Additional properties: true
Example:

{
    "custom_info": "value"
}
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Future dated payment lifecycle event",
    "required": [
        "tracking_id",
        "account_id",
        "status",
        "amount",
        "uncleared_funds",
        "currency"
    ],
    "properties": {
        "tracking_id": {
            "title": "A unique 50-character ID that identifies the future dated payment",
            "type": "string",
            "minLength": 1,
            "maxLength": 50,
            "examples": [
                "UK1-eb75c472-a213-41a7-a96e-ac0156b832f0"
            ]
        },
        "status": {
            "type": "string",
            "title": "Current future dated payment status",
            "description": "\n\nIt only accepts the following values:\n\n<span style='font-weight:bold'>CREATED:</span> When the future dated payment request is created.\n\n<span style='font-weight:bold'>UNSETTLED:</span> When the future dated payment has unsettled values.\n\n<span style='font-weight:bold'>SETTLED:</span>When the future dated payment has been paid in full.\n\n<span style='font-weight:bold'>CANCELED:</span> When the future dated payment was canceled.\n\n<span style='font-weight:bold'>EXPIRED:</span> When the future dated payment has expired.\n\n",
            "minLength": 1,
            "maxLength": 20,
            "enum": [
                "CREATED",
                "UNSETTLED",
                "SETTLED",
                "CANCELED",
                "EXPIRED"
            ],
            "examples": [
                "CREATED"
            ]
        },
        "account_id": {
            "type": "integer",
            "title": "Account identifier",
            "minimum": 1,
            "maximum": 99999999999,
            "examples": [
                5501
            ]
        },
        "external_account_id": {
            "type": [
                "string",
                "null"
            ],
            "title": "External Account identifier",
            "description": "A custom account ID that identifies the account within your organization.",
            "minLength": 1,
            "maxLength": 60,
            "examples": [
                "UK1-2e6e6817-92b2-4ab8-a23e-a50e2f0e6d90"
            ]
        },
        "division_id": {
            "title": "Division unique identifier",
            "description": "Division unique identifier generated by Pismo",
            "type": "string",
            "minLength": 1,
            "maxLength": 36,
            "examples": [
                "7c6138a3-0daa-4a49-aa76-fa03294146b2"
            ]
        },
        "division_code": {
            "type": "string",
            "title": "Division code unique identifier",
            "description": "Code that identifies the division within your organization.",
            "maxLength": 36,
            "examples": [
                "division-code-123"
            ]
        },
        "processing_code": {
            "type": "string",
            "title": "Processing code",
            "description": "Processing code used for posting the future dated payment.",
            "minLength": 1,
            "maxLength": 6,
            "examples": [
                "220041",
                "220043"
            ]
        },
        "amount": {
            "type": "number",
            "title": "Future dated payment amount",
            "minimum": 1,
            "maximum": 18446744073709551617,
            "examples": [
                10.1,
                100.2,
                30
            ]
        },
        "uncleared_funds": {
            "type": "number",
            "title": "The balance of the future dated payment funds that was posted on the account pending for clearance or confirmation.",
            "minimum": 1,
            "maximum": 18446744073709551617,
            "examples": [
                10.1,
                100.2,
                30
            ]
        },
        "currency": {
            "type": "string",
            "title": "A three-letter alphabetic code in ISO 4217 standard that corresponds to the currency used in the earmark transaction",
            "minLength": 1,
            "maxLength": 3,
            "examples": [
                "USD",
                "GBP",
                "BRL"
            ]
        },
        "payment_datetime": {
            "type": [
                "string",
                "null"
            ],
            "title": "Payment timestamp in RFC 3339 date/time format",
            "format": "date-time",
            "examples": [
                "2023-05-20T20:29:59.026Z"
            ]
        },
        "settlement_date": {
            "type": "string",
            "title": "Settlement date",
            "description": "The future dated payment settlement date.",
            "format": "date",
            "examples": [
                "2023-02-06"
            ]
        },
        "internal_operation": {
            "type": [
                "object",
                "null"
            ],
            "title": "Contains the transaction data executed internally",
            "required": [
                "type",
                "tracking_id",
                "amount",
                "created_at"
            ],
            "properties": {
                "type": {
                    "type": "string",
                    "title": "Type of the internal operation",
                    "description": "\n\nIt only accepts the following values:\n\n<span style='font-weight:bold'>INITIAL_PAYMENT:</span> When future dated payment initial payment request is executed.\n\n<span style='font-weight:bold'>SETTLEMENT:</span> When the future dated payment is paid partially/fully.\n\n<span style='font-weight:bold'>CANCELATION:</span> When the future dated payment was canceled.\n\n<span style='font-weight:bold'>EXPIRATION:</span> When the future dated payment has expired.\n\n",
                    "minLength": 1,
                    "maxLength": 20,
                    "enum": [
                        "INITIAL_PAYMENT",
                        "SETTLEMENT",
                        "CANCELATION",
                        "EXPIRATION"
                    ],
                    "examples": [
                        "INITIAL_PAYMENT"
                    ]
                },
                "tracking_id": {
                    "type": "string",
                    "title": "Tracking number that identifies the transaction",
                    "minLength": 1,
                    "maxLength": 50,
                    "examples": [
                        "b12eeb8b-bd3c-4367-b1d6-484c2e4d530a"
                    ]
                },
                "amount": {
                    "type": "number",
                    "title": "Internal operation amount",
                    "minimum": 1,
                    "maximum": 18446744073709551617,
                    "examples": [
                        10.1,
                        100.2,
                        30
                    ]
                },
                "business_date": {
                    "type": "string",
                    "title": "Business date",
                    "description": "The internal operation business date.",
                    "format": "date",
                    "examples": [
                        "2023-02-06"
                    ]
                },
                "created_at": {
                    "type": [
                        "string"
                    ],
                    "title": "RFC 3339 date/time for the operation creation",
                    "format": "date-time",
                    "examples": [
                        "2023-05-20T20:29:59.026Z"
                    ]
                },
                "metadata": {
                    "type": [
                        "object",
                        "null"
                    ],
                    "title": "Key-value fields that contain relevant data your organization needs to store at Pismo",
                    "examples": [
                        {
                            "custom_info": "value"
                        }
                    ],
                    "additionalProperties": true
                }
            }
        }
    }
}
{
    "tracking_id": "UK1-eb75c472-a213-41a7-a96e-ac0156b832f0",
    "status": "CREATED",
    "account_id": 5501,
    "external_account_id": "UK1-2e6e6817-92b2-4ab8-a23e-a50e2f0e6d90",
    "division_id": "7c6138a3-0daa-4a49-aa76-fa03294146b2",
    "division_code": "division-code-123",
    "processing_code": "220041",
    "amount": 10.1,
    "uncleared_funds": 10.1,
    "currency": "USD",
    "payment_datetime": "2023-05-20T20:29:59.026Z",
    "settlement_date": "2023-02-06",
    "internal_operation": {
        "type": "INITIAL_PAYMENT",
        "tracking_id": "b12eeb8b-bd3c-4367-b1d6-484c2e4d530a",
        "amount": 10.1,
        "business_date": "2023-02-06",
        "created_at": "2023-05-20T20:29:59.026Z",
        "metadata": {
            "custom_info": "value"
        }
    }
}