Bank slip issuance canceled

This event occurs when a bank slip issuance is canceled on the Pismo platform. The bank slip issue endpoint generates this event.

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

status required

Title: Status
Description: Bank slip status
Type: string
Example:
CANCELED

external_id required

Title: External ID
Description: External ID generated by the client
Type: string
Example:
80bf9d8154cf-0617-42e1-b500-ce9b8d9b

provider_transaction_id required

Title: Provider transaction ID
Description: Provider transaction ID generated on the provider to identify the bank slip
Type: string
Example:
ce9b8d9b-0617-42e1-b500-80bf9d8154cf

reason required

Title: Reason
Description: Reason related to bankslips cancellation
Type: string
Example:
requested by the client

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Bank slip issuance canceled",
    "description": "This event occurs when a bank slip issuance is canceled on the Pismo platform. The [bank slip issue](https://developers.pismo.io/pismo-docs/reference/delete-integrated-payments-api-v1-bankslips-issue) endpoint generates this event.",
    "required": [
        "status",
        "external_id",
        "provider_transaction_id",
        "reason"
    ],
    "properties": {
        "status": {
            "title": "Status",
            "type": "string",
            "description": "Bank slip status",
            "examples": [
                "CANCELED"
            ]
        },
        "external_id": {
            "title": "External ID",
            "type": "string",
            "description": "External ID generated by the client",
            "examples": [
                "80bf9d8154cf-0617-42e1-b500-ce9b8d9b"
            ]
        },
        "provider_transaction_id": {
            "title": "Provider transaction ID",
            "type": "string",
            "description": "Provider transaction ID generated on the provider to identify the bank slip",
            "examples": [
                "ce9b8d9b-0617-42e1-b500-80bf9d8154cf"
            ]
        },
        "reason": {
            "title": "Reason",
            "type": "string",
            "description": "Reason related to bankslips cancellation",
            "examples": [
                "requested by the client"
            ]
        }
    }
}

{
    "status": "CANCELED",
    "external_id": "80bf9d8154cf-0617-42e1-b500-ce9b8d9b",
    "provider_transaction_id": "ce9b8d9b-0617-42e1-b500-80bf9d8154cf",
    "reason": "requested by the client"
}