Multi-leg payment lifecycle created

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

|
tracking_id required

Title: A unique 43 character long identification for the multi-leg payment
Type: string
Min length: 1
Max length: 43
Example:
UK1-eb75c472-a213-41a7-a96e-ac0156b832f0

debits

Type: array

external_account_id required

Title: External account ID
Description: The external account ID to which the transaction is posted.
Type: string
Min length: 1
Max length: 60
Example:
f8eccb3c-bce1-47b5-a122-f08c9c41b036

amount required

Title: Amount
Description: The amount that will be transacted.
Type: number
Example:
10.1
100.2
30

currency required

Title: Currency alplhabetic code
Description: A 3-letter code in the ISO 4217-compliant format that represents the currency used in the transaction.
Type: string
Min length: 1
Max length: 3
Example:
USD
BRL

processing_code

Title: Processing code
Description: Processing code used for posting the transaction.
Type: string
Min length: 1
Max length: 6
Example:
007700
009900
007200

soft_descriptor

Title: Soft descriptor
Description: A brief description in the bank statement that helps identify a particular transaction.
Type: string
Min length: 0
Max length: 100
Example:
debit operation

earmark_id

Title: Earmark ID
Description: The ID of the earmarked balance from which the amount is withdrawn.
Type: string
Min length: 1
Max length: 60
Example:
9244390a-031f-4140-8cc2-7bd3fcbd35b7

force_post

Title: Force post
Description: Defines whether it is a force debit operation.
Type: boolean
Example:
true

skip_account_date_validation

Title: Skip account date validation
Description: Determines whether or not to validate the transaction date time against the account creation date time.
Type: boolean
Example:
true

credits

Type: array

external_account_id required

Title: External account ID
Description: The external account ID to which the transaction is posted.
Type: string
Min length: 1
Max length: 60
Example:
7d0593c4-e63b-4d45-a041-236c97a8fd17

processing_code required

Title: Processing code
Description: Processing code used for posting the transaction.
Type: string
Min length: 1
Max length: 6
Example:
007700
009900
007200

amount required

Title: Amount
Description: The amount that will be transacted.
Type: number
Example:
10.1
100.2
30

soft_descriptor

Title: Soft descriptor
Description: A brief description in the bank statement that helps identify a particular transaction.
Type: string
Min length: 0
Max length: 100
Example:
credit operation

currency

Title: Currency alplhabetic code
Description: A 3-letter code in the ISO 4217-compliant format that represents the currency used in the transaction.
Type: string
Min length: 1
Max length: 3
Example:
USD
BRL

force_post

Title: Defines whether it is a force credit operation.
Type: boolean
Example:
true

skip_account_date_validation

Title: Skip account date validation
Description: Determines whether or not to validate the transaction date time against the account creation date time.
Type: boolean
Example:
true

metadata

Title: Metadata
Description: This is the field that contains the payment-related data in key-value pair format that Pismo stores for your organization.
Type: object
Example:

{
    "custom_info": "value"
}
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Multi-leg payment lifecycle created",
    "required": [
        "tracking_id"
    ],
    "properties": {
        "tracking_id": {
            "title": "A unique 43 character long identification for the multi-leg payment",
            "type": "string",
            "minLength": 1,
            "maxLength": 43,
            "examples": [
                "UK1-eb75c472-a213-41a7-a96e-ac0156b832f0"
            ]
        },
        "debits": {
            "title": "List of debit legs",
            "type": [
                "array"
            ],
            "items": {
                "type": "object",
                "required": [
                    "external_account_id",
                    "currency",
                    "amount"
                ],
                "properties": {
                    "external_account_id": {
                        "type": "string",
                        "title": "External account ID",
                        "description": "The external account ID to which the transaction is posted.",
                        "minLength": 1,
                        "maxLength": 60,
                        "examples": [
                            "f8eccb3c-bce1-47b5-a122-f08c9c41b036"
                        ]
                    },
                    "amount": {
                        "type": "number",
                        "title": "Amount",
                        "description": "The amount that will be transacted.",
                        "minimum": 0.01,
                        "maximum": 100000000000000000,
                        "examples": [
                            10.1,
                            100.2,
                            30
                        ]
                    },
                    "currency": {
                        "type": "string",
                        "title": "Currency alplhabetic code",
                        "description": "A 3-letter code in the ISO 4217-compliant format that represents the currency used in the transaction.",
                        "minLength": 1,
                        "maxLength": 3,
                        "examples": [
                            "USD",
                            "BRL"
                        ]
                    },
                    "processing_code": {
                        "type": "string",
                        "title": "Processing code",
                        "description": "Processing code used for posting the transaction.",
                        "minLength": 1,
                        "maxLength": 6,
                        "examples": [
                            "007700",
                            "009900",
                            "007200"
                        ]
                    },
                    "soft_descriptor": {
                        "type": "string",
                        "title": "Soft descriptor",
                        "description": "A brief description in the bank statement that helps identify a particular transaction.",
                        "minLength": 0,
                        "maxLength": 100,
                        "examples": [
                            "debit operation"
                        ]
                    },
                    "earmark_id": {
                        "type": "string",
                        "title": "Earmark ID",
                        "description": "The ID of the earmarked balance from which the amount is withdrawn.",
                        "minLength": 1,
                        "maxLength": 60,
                        "examples": [
                            "9244390a-031f-4140-8cc2-7bd3fcbd35b7"
                        ]
                    },
                    "force_post": {
                        "title": "Force post",
                        "description": "Defines whether it is a force debit operation.",
                        "type": "boolean",
                        "examples": [
                            true
                        ]
                    },
                    "skip_account_date_validation": {
                        "type": "boolean",
                        "title": "Skip account date validation",
                        "description": "Determines whether or not to validate the transaction date time against the account creation date time.",
                        "examples": [
                            true
                        ]
                    }
                }
            }
        },
        "credits": {
            "title": "List of credit legs",
            "type": [
                "array"
            ],
            "items": {
                "type": "object",
                "required": [
                    "external_account_id",
                    "processing_code",
                    "amount"
                ],
                "properties": {
                    "external_account_id": {
                        "type": "string",
                        "title": "External account ID",
                        "description": "The external account ID to which the transaction is posted.",
                        "minLength": 1,
                        "maxLength": 60,
                        "examples": [
                            "7d0593c4-e63b-4d45-a041-236c97a8fd17"
                        ]
                    },
                    "processing_code": {
                        "type": "string",
                        "title": "Processing code",
                        "description": "Processing code used for posting the transaction.",
                        "minLength": 1,
                        "maxLength": 6,
                        "examples": [
                            "007700",
                            "009900",
                            "007200"
                        ]
                    },
                    "amount": {
                        "type": "number",
                        "title": "Amount",
                        "description": "The amount that will be transacted.",
                        "minimum": 0.01,
                        "maximum": 100000000000000000,
                        "examples": [
                            10.1,
                            100.2,
                            30
                        ]
                    },
                    "soft_descriptor": {
                        "type": "string",
                        "title": "Soft descriptor",
                        "description": "A brief description in the bank statement that helps identify a particular transaction.",
                        "minLength": 0,
                        "maxLength": 100,
                        "examples": [
                            "credit operation"
                        ]
                    },
                    "currency": {
                        "type": "string",
                        "title": "Currency alplhabetic code",
                        "description": "A 3-letter code in the ISO 4217-compliant format that represents the currency used in the transaction.",
                        "minLength": 1,
                        "maxLength": 3,
                        "examples": [
                            "USD",
                            "BRL"
                        ]
                    },
                    "force_post": {
                        "title": "Defines whether it is a force credit operation.",
                        "type": "boolean",
                        "examples": [
                            true
                        ]
                    },
                    "skip_account_date_validation": {
                        "type": "boolean",
                        "title": "Skip account date validation",
                        "description": "Determines whether or not to validate the transaction date time against the account creation date time.",
                        "examples": [
                            true
                        ]
                    }
                }
            }
        },
        "metadata": {
            "type": "object",
            "title": "Metadata",
            "description": "This is the field that contains the payment-related data in key-value pair format that Pismo stores for your organization.",
            "examples": [
                {
                    "custom_info": "value"
                }
            ]
        }
    }
}
{
    "tracking_id": "UK1-eb75c472-a213-41a7-a96e-ac0156b832f0",
    "debits": {
        "external_account_id": "f8eccb3c-bce1-47b5-a122-f08c9c41b036",
        "amount": 10.1,
        "currency": "USD",
        "processing_code": "007700",
        "soft_descriptor": "debit operation",
        "earmark_id": "9244390a-031f-4140-8cc2-7bd3fcbd35b7",
        "force_post": true,
        "skip_account_date_validation": true
    },
    "credits": {
        "external_account_id": "7d0593c4-e63b-4d45-a041-236c97a8fd17",
        "processing_code": "007700",
        "amount": 10.1,
        "soft_descriptor": "credit operation",
        "currency": "USD",
        "force_post": true,
        "skip_account_date_validation": true
    },
    "metadata": {
        "custom_info": "value"
    }
}