Bank slip issuance registered

This event occurs when a bank slip is registered on the Pismo platform. The Issue bank slip endpoint generates this event.

Type: object
Domain: integrated-payments
Event: bankslip_issue_register
Version: 1

amount required

Title: Amount
Description: Bank slip amount
Type: number
Example:
100.0

debtor required

Title: Debtor object
Description: Debtor's personal information
Type: object

name required

Title: Name
Description: Debtor's full name
Type: string
Example:
John Doe

document_number required

Title: Document Number
Description: Debtor's Document Number
Type: string
Example:
9999099999

zip_code

Title: Zip code
Description: Zip code
Type: string
Example:
00000350

state

Title: State
Description: The name of the state
Type: string
Example:
state

city

Title: City
Description: City where the debtor resides
Type: string
Example:
city

neighborhood

Title: Neighborhood
Description: Neighborhood name where the debtor resides
Type: string
Example:
neighborhood

street

Title: Street
Description: The name of the street where the debtor resides
Type: string
Example:
street

number

Title: Number
Description: Street number
Type: string
Example:
1009

complement

Title: Complement
Description: Additional address
Type: string
Example:
additional address

due_date required

Title: Due date
Description: Bank slip due date
Type: string
Format: date
Example:
2023-01-01

instructions required

Title: Instructions object
Description: Additional Instructions of bank slip related to taxes and discount
Type: object

fine

Title: Fine
Description: Fine to be applied to the bank slip amount if overdue
Type: number
Example:
1.0

interest

Title: Interest
Description: Interest to be applied to the bank slips amount when overdue
Type: number
Example:
5.0

discount

Title: Discount object
Description: Discount value and due date applied to the banks slip
Type: object

type

Title: Type
Description: Bank slip discount type.
FIXED: Fixed discount amount.
PERCENT: Discount percentage.
Type: string
Must be one of the following:
FIXED
PERCENT

amount

Title: Amount
Description: Discounted amount to be applied to the bank slip amount if paid before or on the deadline
Type: number
Example:
10.0

deadline

Title: Deadline
Description: Deadline of discount value applied to the bank slip
Type: string
Format: date-time
Example:
10.0

over_due_date required

Title: Over due date
Description: Last day to accept bank slip payments. After this date, the bank slip is treated as not paid
Type: string
Format: date
Example:
2023-01-01

receiver required

Title: Receiver object
Description: Recipient's personal information
Type: object

name required

Title: Name
Description: Recipient's Name
Type: string
Example:
John Doe

document_number required

Title: Document Number
Description: Recipient's Document Number
Type: string
Example:
9999099999

description

Title: Description
Description: Additional information related to bank slip
Type: string
Example:
description can include any additional information related to the bank slip

minimum_amount

Title: Minimum amount
Description: Minimum amount accepted when paying the bank slip
Type: number
Example:
100.0

maximum_amount

Title: Maximum amount
Description: Maximum amount accepted when paying the bank slip
Type: number
Example:
100.0

pix_key

Title: Pix key
Description: PIX key related to the bank slip
Type: string
Example:
[email protected]

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Bank slip issuance registered",
    "description": "This event occurs when a bank slip is registered on the Pismo platform. The [Issue bank slip](https://developers.pismo.io/pismo-docs/reference/post-integrated-payments-api-v1-bankslips-issue) endpoint generates this event.",
    "required": [
        "amount",
        "debtor",
        "due_date",
        "instructions",
        "over_due_date",
        "receiver"
    ],
    "optional": [
        "description",
        "minimum_amount",
        "maximum_amount",
        "pix_key"
    ],
    "properties": {
        "amount": {
            "title": "Amount",
            "type": "number",
            "description": "Bank slip amount",
            "examples": [
                100.0
            ]
        },
        "debtor": {
            "type": "object",
            "title": "Debtor object",
            "description": "Debtor's personal information",
            "required": [
                "name",
                "document_number"
            ],
            "properties": {
                "name": {
                    "type": "string",
                    "title": "Name",
                    "description": "Debtor's full name",
                    "examples": [
                        "John Doe"
                    ]
                },
                "document_number": {
                    "type": "string",
                    "title": "Document Number",
                    "description": "Debtor's Document Number",
                    "examples": [
                        "9999099999"
                    ]
                },
                "zip_code": {
                    "type": "string",
                    "title": "Zip code",
                    "description": "Zip code",
                    "examples": [
                        "00000350"
                    ]
                },
                "state": {
                    "type": "string",
                    "title": "State",
                    "description": "The name of the state",
                    "examples": [
                        "state"
                    ]
                },
                "city": {
                    "type": "string",
                    "title": "City",
                    "description": "City where the debtor resides",
                    "examples": [
                        "city"
                    ]
                },
                "neighborhood": {
                    "type": "string",
                    "title": "Neighborhood",
                    "description": "Neighborhood name where the debtor resides",
                    "examples": [
                        "neighborhood"
                    ]
                },
                "street": {
                    "type": "string",
                    "title": "Street",
                    "description": "The name of the street where the debtor resides",
                    "examples": [
                        "street"
                    ]
                },
                "number": {
                    "type": "string",
                    "title": "Number",
                    "description": "Street number",
                    "examples": [
                        "1009"
                    ]
                },
                "complement": {
                    "type": "string",
                    "title": "Complement",
                    "description": "Additional address",
                    "examples": [
                        "additional address"
                    ]
                }
            }
        },
        "due_date": {
            "title": "Due date",
            "type": "string",
            "format": "date",
            "description": "Bank slip due date",
            "examples": [
                "2023-01-01"
            ]
        },
        "instructions": {
            "type": "object",
            "title": "Instructions object",
            "description": "Additional Instructions of bank slip related to taxes and discount",
            "properties": {
                "fine": {
                    "type": "number",
                    "title": "Fine",
                    "description": "Fine to be applied to the bank slip amount if overdue",
                    "examples": [
                        1.0
                    ]
                },
                "interest": {
                    "type": "number",
                    "title": "Interest",
                    "description": "Interest to be applied to the bank slips amount when overdue",
                    "examples": [
                        5.0
                    ]
                },
                "discount": {
                    "type": "object",
                    "title": "Discount object",
                    "description": "Discount value and due date applied to the banks slip",
                    "properties": {
                        "type": {
                            "type": "string",
                            "title": "Type",
                            "description": "Bank slip discount type.\n\n<span style='font-weight:bold'>FIXED</span>: Fixed discount amount.\n\n<span style='font-weight:bold'>PERCENT</span>: Discount percentage.",
                            "enum": [
                                "FIXED",
                                "PERCENT"
                            ]
                        },
                        "amount": {
                            "type": "number",
                            "title": "Amount",
                            "description": "Discounted amount to be applied to the bank slip amount if paid before or on the deadline",
                            "examples": [
                                10.0
                            ]
                        },
                        "deadline": {
                            "type": "string",
                            "format": "date-time",
                            "title": "Deadline",
                            "description": "Deadline of discount value applied to the bank slip",
                            "examples": [
                                10.0
                            ]
                        }
                    }
                }
            }
        },
        "over_due_date": {
            "title": "Over due date",
            "type": "string",
            "format": "date",
            "description": "Last day to accept bank slip payments. After this date, the bank slip is treated as not paid",
            "examples": [
                "2023-01-01"
            ]
        },
        "receiver": {
            "type": "object",
            "title": "Receiver object",
            "description": "Recipient's personal information",
            "required": [
                "name",
                "document_number"
            ],
            "properties": {
                "name": {
                    "type": "string",
                    "title": "Name",
                    "description": "Recipient's Name",
                    "examples": [
                        "John Doe"
                    ]
                },
                "document_number": {
                    "type": "string",
                    "title": "Document Number",
                    "description": "Recipient's Document Number",
                    "examples": [
                        "9999099999"
                    ]
                }
            }
        },
        "description": {
            "title": "Description",
            "type": "string",
            "description": "Additional information related to bank slip",
            "examples": [
                "description can include any additional information related to the bank slip"
            ]
        },
        "minimum_amount": {
            "title": "Minimum amount",
            "type": "number",
            "description": "Minimum amount accepted when paying the bank slip",
            "examples": [
                100.0
            ]
        },
        "maximum_amount": {
            "title": "Maximum amount",
            "type": "number",
            "description": "Maximum amount accepted when paying the bank slip",
            "examples": [
                100.0
            ]
        },
        "pix_key": {
            "title": "Pix key",
            "type": "string",
            "description": "PIX key related to the bank slip",
            "examples": [
                "[email protected]"
            ]
        }
    }
}

{
    "amount": 100.0,
    "debtor": {
        "name": "John Doe",
        "document_number": "9999099999",
        "zip_code": "00000350",
        "state": "state",
        "city": "city",
        "neighborhood": "neighborhood",
        "street": "street",
        "number": "1009",
        "complement": "additional address"
    },
    "due_date": "2023-01-01",
    "instructions": {
        "fine": 1.0,
        "interest": 5.0,
        "discount": {
            "type": "FIXED",
            "amount": 10.0,
            "deadline": 10.0
        }
    },
    "over_due_date": "2023-01-01",
    "receiver": {
        "name": "John Doe",
        "document_number": "9999099999"
    },
    "description": "description can include any additional information related to the bank slip",
    "minimum_amount": 100.0,
    "maximum_amount": 100.0,
    "pix_key": "[email protected]"
}