Financial bank slip status changed

This event occurs when a financial bank slip status changes on the Pismo platform. The Pay bank slip endpoint generates this event.

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

account_id required

Title: Account ID
Description: Pismo account ID
Type: integer
Example:
8675309

authorization_id required

Title: Authorization ID
Description: Pismo authorization ID
Type: integer
Example:
765833

provider_id

Title: Provider bank slip ID
Description: Provider bank slip ID
Type: string
Example:
78ebbdeb-5084-4741-b2af-0b531f9d1099

new_status required

Title: New bank slip status
Description: Bank slip's new status
Type: string
Must be one of the following:
PROCESSING
SETTLED
PAID
CANCELLED
ERROR
Example:
PAID

old_status required

Title: Old bank slip status
Description: Bank slip's old status
Type: string
Must be one of the following:
PROCESSING
SETTLED
PAID
CANCELLED
ERROR
Example:
SETTLED

amount required

Title: Bank slip amount
Description: Bank slip amount
Type: number
Format: double
Example:
86753.09

due_datetime required

Title: due date
Description: Bank slip due date.
Type: string
Format: date-time
Example:
2022-09-26T00:00:00Z

digitable_line

Title: Digitable line number
Description: Bank slip digitable line number without the formatting
Type: string
Example:
20890001091000001090980008176705191030000002000

bar_code

Title: Bar code
Description: Bank slip bar code
Type: string
Example:
20890001091000001090980008176705191030000002000

payment_datetime required

Title: due date
Description: Bank slip payment datetime
Type: string
Format: date-time
Example:
2022-09-26T00:00:00Z

update_datetime required

Title: Update datetime
Description: Bank slip update payment date time
Type: string
Format: date-time
Example:
2022-09-26T00:00:00Z

settlement_partner

Title: Settlement Partner
Description: the institution used to settle the Bank slip
Type: string
Example:
509 | CELCOIN INST. PAGAMENTO SA / AGENCIA 0001

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Financial bank slip status changed",
    "description": "This event occurs when a financial bank slip status changes on the Pismo platform. The [Pay bank slip](https://developers.pismo.io/pismo-docs/reference/post-integrated-payments-api-v1-bankslips-pay) endpoint generates this event.",
    "required": [
        "account_id",
        "authorization_id",
        "new_status",
        "old_status",
        "amount",
        "due_datetime",
        "payment_datetime",
        "update_datetime"
    ],
    "optional": [
        "settlement_partner"
    ],
    "properties": {
        "account_id": {
            "type": "integer",
            "title": "Account ID",
            "description": "Pismo account ID",
            "examples": [
                8675309
            ]
        },
        "authorization_id": {
            "type": "integer",
            "title": "Authorization ID",
            "description": "Pismo authorization ID",
            "examples": [
                765833
            ]
        },
        "provider_id": {
            "type": "string",
            "title": "Provider bank slip ID",
            "description": "Provider bank slip ID",
            "examples": [
                "78ebbdeb-5084-4741-b2af-0b531f9d1099"
            ]
        },
        "new_status": {
            "type": "string",
            "title": "New bank slip status",
            "description": "Bank slip's new status",
            "enum": [
                "PROCESSING",
                "SETTLED",
                "PAID",
                "CANCELLED",
                "ERROR"
            ],
            "example": "PAID"
        },
        "old_status": {
            "type": "string",
            "title": "Old bank slip status",
            "description": "Bank slip's old status",
            "enum": [
                "PROCESSING",
                "SETTLED",
                "PAID",
                "CANCELLED",
                "ERROR"
            ],
            "example": "SETTLED"
        },
        "amount": {
            "type": "number",
            "format": "double",
            "title": "Bank slip amount",
            "description": "Bank slip amount",
            "examples": [
                86753.09
            ]
        },
        "due_datetime": {
            "type": "string",
            "title": "due date",
            "description": "Bank slip due date.",
            "format": "date-time",
            "examples": [
                "2022-09-26T00:00:00Z"
            ]
        },
        "digitable_line": {
            "type": "string",
            "title": "Digitable line number",
            "description": "Bank slip digitable line number without the formatting",
            "examples": [
                "20890001091000001090980008176705191030000002000"
            ]
        },
        "bar_code": {
            "type": "string",
            "title": "Bar code",
            "description": "Bank slip bar code",
            "examples": [
                "20890001091000001090980008176705191030000002000"
            ]
        },
        "payment_datetime": {
            "type": "string",
            "title": "due date",
            "description": "Bank slip payment datetime",
            "format": "date-time",
            "examples": [
                "2022-09-26T00:00:00Z"
            ]
        },
        "update_datetime": {
            "type": "string",
            "title": "Update datetime",
            "description": "Bank slip update payment date time",
            "format": "date-time",
            "examples": [
                "2022-09-26T00:00:00Z"
            ]
        },
        "settlement_partner": {
            "type": "string",
            "title": "Settlement Partner",
            "description": "the institution used to settle the Bank slip",
            "examples": [
                "509 | CELCOIN INST. PAGAMENTO SA / AGENCIA 0001"
            ]
        }
    }
}

{
    "account_id": 8675309,
    "authorization_id": 765833,
    "provider_id": "78ebbdeb-5084-4741-b2af-0b531f9d1099",
    "new_status": "PAID",
    "old_status": "SETTLED",
    "amount": 86753.09,
    "due_datetime": "2022-09-26T00:00:00Z",
    "digitable_line": "20890001091000001090980008176705191030000002000",
    "bar_code": "20890001091000001090980008176705191030000002000",
    "payment_datetime": "2022-09-26T00:00:00Z",
    "update_datetime": "2022-09-26T00:00:00Z",
    "settlement_partner": "509 | CELCOIN INST. PAGAMENTO SA / AGENCIA 0001"
}

Updated 15 days ago