Transaction updated

This event occurs when a transaction is updated.

Type: object
Domain: transaction
Event: update
Version: 1

|
id required

Title: Transaction ID
Description: Transaction unique identifier
Type: integer
Example:
1
2
3

account_id required

Title: Account ID
Description: Account unique identifier
Type: integer
Example:
1
2

customer_id

Title: Customer ID
Description: Customer unique identifier
Type: integer or null
Example:
1
2

program required

Title: Program
Description: Program associated with transaction
Type: object

id required

Title: Program ID
Description: Program unique identifier
Type: integer
Example:
1
2

name required

Title: Program name
Description: Program name
Type: string
Example:
Black Card
Acme Account

type required

Title: Program type
Description: Program type
Type: string
Example:
CREDIT
DEBIT
DIGITAL ACCOUNT

transaction_type required

Title: Transaction type
Description: Transaction type information
Type: object
Example:
{'id': 1, 'description': 'COMPRA A VISTA', 'is_credit': True, 'statement_post': True}
{'id': 2, 'description': 'COMPRA INTERNACIONAL', 'is_credit': True, 'statement_post': True}

id required

Description: Transation type ID
Type: integer
Example:
1
2

description required

Title: Transaction type description
Description: Transaction type description
Type: string
Example:
COMPRA A VISTA
COMPRA INTERNACIONAL
PARCELADO SEM JUROS
PARCELA SEM JUROS
PARCELADO COM JUROS
PARCELA COM JUROS
SAQUE

is_credit required

Description: Indicates if the transaction type is a credit (true) or debit (false) operation.
Type: boolean

statement_post required

Description: Indicates if the transaction is posted on the statement (true) or not (false).
Type: boolean

amount required

Title: Transaction amount
Description: Transaction amounts and currencies
Type: array

currency required

Title: Currency code
Description: ISO 4217 currency code or null
Type: string or null
Example:
BRL
USD

value required

Title: Transaction amount
Description: Amount of the transaction
Type: number

description

Title: Amount type
Description: Amount type
Type: string or null
Example:
TRANSACTION_AMOUNT
LOCAL_AMOUNT
SETTLEMENT_CURRENCY_AMOUNT

event_date required

Title: Event timestamp (ISO 8601)
Description: Event timestamp in the UTC (zero-hour offset) ISO 8601 format (yyyy-MM-ddThh:mm:ssZ).
Type: string
Format: date-time
Example:
2019-09-04T22:13:03Z

event_datetime required

Title: Event timestamp (RFC 3339)
Description: Event timestamp in the UTC (zero-hour offset) RFC 3339 format, which includes milliseconds (yyyy-MM-ddThh:mm:ss.SSSZ).
Type: string
Format: date-time
Example:
2019-09-04T22:13:03.000Z

payment_date

Title: Payment timestamp (ISO 8601)
Description: Payment timestamp in the ISO 8601 format (yyyy-MM-ddThh:mm:ssZ).
Type: string or null
Format: date-time
Example:
2019-09-04T22:13:03Z

payment_datetime

Title: Payment timestamp (RFC 3339)
Description: Payment timestamp in the RFC3339 format, which includes milliseconds (yyyy-MM-ddThh:mm:ss.SSSZ).
Type: string or null
Format: date-time
Example:
2019-09-04T22:13:03.000Z

accounting_date required

Title: Accounting date
Description: Settlement date (only business days)
Type: string
Format: date
Example:
2019-02-04

soft_descriptor

Title: Soft descriptor
Description: Temporary description that appears on the statement immediately after a transaction. This value is replaced by a permanent billing descriptor after the transaction settles.
Type: string or null
Example:
Adjustment made by a operator

authorization required

Title: Authorization
Description: Object created when a transaction is approved. Represents a record of the authorization.
Type: object

type required

Title: Authorization type
Description: Authorization type
Type: string or null
Min length: 0
Max length: 30
Example:
VISA
MASTERCARD
WALLET
PLATFORM

id required

Title: Authorization ID
Description: Authorization unique identifier
Type: integer or null
Example:
1
2

tid

Title: External authorization ID
Description: Unique identifier for external authorization
Type: string or null
Example:
1231AB

card_id

Title: Card ID
Description: Card unique identifier
Type: string or null
Example:
1
2

card_hash

Title: Card hash
Description: Hash generated using card PAN (Primary Account Number)
Type: string or null
Example:
1231231-123123-1231231

authorization_code

Title: Authorization code
Description: Authorization code identifier
Type: string or null
Example:
Y0IKQJ

retrieval_reference_number

Title: Retrieval reference number
Description: Retrieval reference number. Provided by Authorization domain.
Type: string or null
Example:
932614326272

principal_amount

Title: Principal amount
Description: Principal amount of transaction
Type: number or null
Example:
123.45

correlated_authorization_id

Title: Correlated authorization ID
Description: Authorization ID generated by force or installment operations when the original_authorization field is provided. See the Force operation and Installments payment guides for more information.
Type: integer or null
Example:
11443744043709851610
10406740073209351312

installment

Title: Installment number
Description: Number of this installment
Type: integer or null
Example:
1
2

number_of_installments

Description: Number of installments
Type: integer or null
Example:
4
5

user_category

Title: User category
Description: Category of transaction defined by the account user
Type: string or null
Example:
health
sports

transaction_group

Title: Transaction group
Description: Transaction group defined by program
Type: string or null
Example:
TAXES_AND_FEES
NATIONAL
INSTALLMENT

correlation_id required

Title: Correlation ID
Description: The Correlation IDentifier field is used to link related API requests and events.
Type: string
Example:
3bd713ad-4ffd-93d5-9eaa-2c52f59582e0

due_date

Title: Due date
Description: Statement due date (ISO 8601)
Type: string or null
Format: date
Example:
2019-02-04

tax

Title: Tax
Description: Transaction tax
Type: array or null
Example:

[
    {
        "type": "IOF",
        "value": 100.0
    }
]
type required

Title: Tax type
Description: Tax type – IOF, DAILY_IOF, or INTEREST.
Type: string
Must be one of the following:
IOF
DAILY_IOF
INTEREST
Example:
IOF

value required

Title: Tax value
Description: Amount of tax
Type: number

details

Title: Details
Description: Transaction metadata. This is a JSON object converted to a string.
Type: string or null
Example:
{'teste':'teste'}

interest_rate

Title: Interest rate
Description: Interest rate on the transaction
Type: number or null
Example:
20.5
null

statement_id

Title: Statement ID
Description: ID of the statement on which the transaction appears
Type: number or null
Example:
1
955

processing_code

Title: Processing code
Description: Processing code used to generate the transaction
Type: string or null
Example:
PC_123

processing_description

Title: Processing code
Description: Description of the processing code. Each code has a pre-defined description.
Type: string or null
Example:
DEBIT PURCHASE

origin

Title: Transaction origin
Description: Origin of the transaction. Default value is null, which means that the transaction originated from the Pismo platform. Other values indicate that the transaction came from another platform and was then migrated to the Pismo platform.
Type: string or null
Example:
MIGRATION

authorization_tracking_id

Description: Authorization tracking ID
Type: string or null
Example:
b7620539-eb50-46a1-aa2c-cc413cace8ab

reference_to_cardholder_exchange_rate

Title: Reference to cardholder exchange rate
Description: Conversion rate used to convert the local currency purchase to the cardholder currency.
Type: number or null
Example:
5.23
null

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Transaction updated",
    "description": "This event occurs when a transaction is updated.",
    "required": [
        "id",
        "account_id",
        "program",
        "transaction_type",
        "amount",
        "event_date",
        "event_datetime",
        "accounting_date",
        "authorization",
        "correlation_id"
    ],
    "properties": {
        "id": {
            "type": "integer",
            "title": "Transaction ID",
            "description": "Transaction unique identifier",
            "examples": [
                1,
                2,
                3
            ]
        },
        "account_id": {
            "type": "integer",
            "title": "Account ID",
            "description": "Account unique identifier",
            "examples": [
                1,
                2
            ]
        },
        "customer_id": {
            "type": [
                "integer",
                "null"
            ],
            "title": "Customer ID",
            "description": "Customer unique identifier",
            "examples": [
                1,
                2
            ]
        },
        "program": {
            "type": "object",
            "title": "Program",
            "description": "Program associated with transaction",
            "required": [
                "id",
                "name",
                "type"
            ],
            "properties": {
                "id": {
                    "type": "integer",
                    "title": "Program ID",
                    "description": "Program unique identifier",
                    "examples": [
                        1,
                        2
                    ]
                },
                "name": {
                    "type": "string",
                    "title": "Program name",
                    "description": "Program name",
                    "examples": [
                        "Black Card",
                        "Acme Account"
                    ]
                },
                "type": {
                    "type": "string",
                    "title": "Program type",
                    "description": "Program type",
                    "examples": [
                        "CREDIT",
                        "DEBIT",
                        "DIGITAL ACCOUNT"
                    ]
                }
            }
        },
        "transaction_type": {
            "type": "object",
            "title": "Transaction type",
            "description": "Transaction type information",
            "required": [
                "id",
                "description",
                "is_credit",
                "statement_post"
            ],
            "properties": {
                "id": {
                    "type": "integer",
                    "description": "Transation type ID",
                    "examples": [
                        1,
                        2
                    ]
                },
                "description": {
                    "type": "string",
                    "title": "Transaction type description",
                    "description": "Transaction type description",
                    "examples": [
                        "COMPRA A VISTA",
                        "COMPRA INTERNACIONAL",
                        "PARCELADO SEM JUROS",
                        "PARCELA SEM JUROS",
                        "PARCELADO COM JUROS",
                        "PARCELA COM JUROS",
                        "SAQUE"
                    ]
                },
                "is_credit": {
                    "type": "boolean",
                    "description": "Indicates if the transaction type is a credit (true) or debit (false) operation."
                },
                "statement_post": {
                    "type": "boolean",
                    "description": "Indicates if the transaction is posted on the statement (`true`) or not (`false`)."
                }
            },
            "examples": [
                {
                    "id": 1,
                    "description": "COMPRA A VISTA",
                    "is_credit": true,
                    "statement_post": true
                },
                {
                    "id": 2,
                    "description": "COMPRA INTERNACIONAL",
                    "is_credit": true,
                    "statement_post": true
                }
            ]
        },
        "amount": {
            "type": "array",
            "description": "Transaction amounts and currencies",
            "items": [
                {
                    "type": "object",
                    "title": "Transaction amount",
                    "description": "Represents transaction amount. Contains the currency, amount, and an optional description of the transaction.",
                    "required": [
                        "currency",
                        "value"
                    ],
                    "properties": {
                        "currency": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Currency code",
                            "description": "ISO 4217 currency code or null",
                            "examples": [
                                "BRL",
                                "USD"
                            ]
                        },
                        "value": {
                            "type": "number",
                            "title": "Transaction amount",
                            "description": "Amount of the transaction"
                        },
                        "description": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Amount type",
                            "description": "Amount type",
                            "examples": [
                                "TRANSACTION_AMOUNT",
                                "LOCAL_AMOUNT",
                                "SETTLEMENT_CURRENCY_AMOUNT"
                            ]
                        }
                    }
                }
            ],
            "examples": [
                {
                    "currency": "BRL",
                    "value": 10.5,
                    "description": "TRANSACTION_AMOUNT"
                },
                {
                    "currency": "BRL",
                    "value": 1.99,
                    "description": "LOCAL_AMOUNT"
                },
                {
                    "currency": "USD",
                    "value": 10.5,
                    "description": "SETTLEMENT_CURRENCY_AMOUNT"
                }
            ]
        },
        "event_date": {
            "type": "string",
            "title": "Event timestamp (ISO 8601)",
            "description": "Event timestamp in the UTC (zero-hour offset) ISO 8601 format (yyyy-MM-ddThh:mm:ssZ).",
            "format": "date-time",
            "examples": [
                "2019-09-04T22:13:03Z"
            ]
        },
        "event_datetime": {
            "type": "string",
            "title": "Event timestamp (RFC 3339)",
            "description": "Event timestamp in the UTC (zero-hour offset) RFC 3339 format, which includes milliseconds (yyyy-MM-ddThh:mm:ss.SSSZ).",
            "format": "date-time",
            "examples": [
                "2019-09-04T22:13:03.000Z"
            ]
        },
        "payment_date": {
            "type": [
                "string",
                "null"
            ],
            "title": "Payment timestamp (ISO 8601)",
            "description": "Payment timestamp in the ISO 8601 format (yyyy-MM-ddThh:mm:ssZ).",
            "format": "date-time",
            "examples": [
                "2019-09-04T22:13:03Z"
            ]
        },
        "payment_datetime": {
            "title": "Payment timestamp (RFC 3339)",
            "description": "Payment timestamp in the RFC3339 format, which includes milliseconds (yyyy-MM-ddThh:mm:ss.SSSZ).",
            "type": [
                "string",
                "null"
            ],
            "format": "date-time",
            "examples": [
                "2019-09-04T22:13:03.000Z"
            ]
        },
        "accounting_date": {
            "type": "string",
            "title": "Accounting date",
            "description": "Settlement date (only business days)",
            "format": "date",
            "examples": [
                "2019-02-04"
            ]
        },
        "soft_descriptor": {
            "type": [
                "string",
                "null"
            ],
            "title": "Soft descriptor",
            "description": "Temporary description that appears on the statement immediately after a transaction. This value is replaced by a permanent billing descriptor after the transaction settles.",
            "examples": [
                "Adjustment made by a operator"
            ]
        },
        "authorization": {
            "type": "object",
            "title": "Authorization",
            "description": "Object created when a transaction is approved. Represents a record of the authorization.",
            "required": [
                "type",
                "id"
            ],
            "properties": {
                "type": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Authorization type",
                    "description": "Authorization type",
                    "minLength": 0,
                    "maxLength": 30,
                    "examples": [
                        "VISA",
                        "MASTERCARD",
                        "WALLET",
                        "PLATFORM"
                    ]
                },
                "id": {
                    "type": [
                        "integer",
                        "null"
                    ],
                    "title": "Authorization ID",
                    "description": "Authorization unique identifier",
                    "examples": [
                        1,
                        2
                    ]
                },
                "tid": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "External authorization ID",
                    "description": "Unique identifier for external authorization",
                    "examples": [
                        "1231AB"
                    ]
                },
                "card_id": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Card ID",
                    "description": "Card unique identifier",
                    "examples": [
                        1,
                        2
                    ]
                },
                "card_hash": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Card hash",
                    "description": "Hash generated using card PAN (Primary Account Number)",
                    "examples": [
                        "1231231-123123-1231231"
                    ]
                },
                "authorization_code": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Authorization code",
                    "description": "Authorization code identifier",
                    "examples": [
                        "Y0IKQJ"
                    ]
                },
                "retrieval_reference_number": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Retrieval reference number",
                    "description": "Retrieval reference number. Provided by Authorization domain.",
                    "example": [
                        "932614326272"
                    ]
                },
                "principal_amount": {
                    "type": [
                        "number",
                        "null"
                    ],
                    "title": "Principal amount",
                    "description": "Principal amount of transaction",
                    "example": [
                        123.45
                    ]
                },
                "correlated_authorization_id": {
                    "title": "Correlated authorization ID",
                    "description": "Authorization ID generated by force or installment operations when the `original_authorization` field is provided. See the <a href='https://developers.pismo.io/pismo-docs/docs/force-operation' target='_blank'>Force operation</a> and <a href='https://developers.pismo.io/pismo-docs/docs/installments-payment' target='_blank'>Installments payment</a> guides for more information.",
                    "type": [
                        "integer",
                        "null"
                    ],
                    "minimum": 0,
                    "maximum": 18446744073709551617,
                    "examples": [
                        11443744043709851610,
                        10406740073209351312
                    ]
                }
            }
        },
        "installment": {
            "type": [
                "integer",
                "null"
            ],
            "title": "Installment number",
            "description": "Number of this installment",
            "examples": [
                1,
                2
            ]
        },
        "number_of_installments": {
            "type": [
                "integer",
                "null"
            ],
            "description": "Number of installments",
            "examples": [
                4,
                5
            ]
        },
        "user_category": {
            "type": [
                "string",
                "null"
            ],
            "title": "User category",
            "description": "Category of transaction defined by the account user",
            "examples": [
                "health",
                "sports"
            ]
        },
        "transaction_group": {
            "type": [
                "string",
                "null"
            ],
            "title": "Transaction group",
            "description": "Transaction group defined by program",
            "examples": [
                "TAXES_AND_FEES",
                "NATIONAL",
                "INSTALLMENT"
            ]
        },
        "correlation_id": {
            "type": "string",
            "title": "Correlation ID",
            "description": "The Correlation IDentifier field is used to link related API requests and events.",
            "examples": [
                "3bd713ad-4ffd-93d5-9eaa-2c52f59582e0"
            ]
        },
        "due_date": {
            "type": [
                "string",
                "null"
            ],
            "title": "Due date",
            "description": "Statement due date (ISO 8601)",
            "format": "date",
            "examples": [
                "2019-02-04"
            ]
        },
        "tax": {
            "type": [
                "array",
                "null"
            ],
            "title": "Tax",
            "description": "Transaction tax",
            "items": [
                {
                    "type": "object",
                    "title": "Transaction tax",
                    "description": "Represents one tax in an array of one or more taxes applied to the transaction. Contains the amount and type of the tax.",
                    "required": [
                        "type",
                        "value"
                    ],
                    "properties": {
                        "type": {
                            "type": "string",
                            "title": "Tax type",
                            "description": "Tax type \u2013 IOF, DAILY_IOF, or INTEREST.",
                            "enum": [
                                "IOF",
                                "DAILY_IOF",
                                "INTEREST"
                            ],
                            "examples": [
                                "IOF"
                            ]
                        },
                        "value": {
                            "type": "number",
                            "title": "Tax value",
                            "description": "Amount of tax"
                        }
                    },
                    "examples": [
                        {
                            "type": "IOF",
                            "value": 100.0
                        }
                    ]
                }
            ]
        },
        "details": {
            "type": [
                "string",
                "null"
            ],
            "title": "Details",
            "description": "Transaction metadata. This is a JSON object converted to a string.",
            "examples": [
                "{'teste':'teste'}"
            ]
        },
        "interest_rate": {
            "type": [
                "number",
                "null"
            ],
            "title": "Interest rate",
            "description": "Interest rate on the transaction",
            "examples": [
                20.5,
                0.0
            ]
        },
        "statement_id": {
            "type": [
                "number",
                "null"
            ],
            "title": "Statement ID",
            "description": "ID of the statement on which the transaction appears",
            "examples": [
                1,
                955
            ]
        },
        "processing_code": {
            "type": [
                "string",
                "null"
            ],
            "title": "Processing code",
            "description": "Processing code used to generate the transaction",
            "examples": [
                "PC_123"
            ]
        },
        "processing_description": {
            "type": [
                "string",
                "null"
            ],
            "title": "Processing code",
            "description": "Description of the processing code. Each code has a pre-defined description.",
            "examples": [
                "DEBIT PURCHASE"
            ]
        },
        "origin": {
            "type": [
                "string",
                "null"
            ],
            "title": "Transaction origin",
            "description": "Origin of the transaction. Default value is null, which means that the transaction originated from the Pismo platform. Other values indicate that the transaction came from another platform and was then migrated to the Pismo platform.",
            "examples": [
                "MIGRATION"
            ]
        },
        "authorization_tracking_id": {
            "type": [
                "string",
                "null"
            ],
            "description": "Authorization tracking ID",
            "examples": [
                "b7620539-eb50-46a1-aa2c-cc413cace8ab"
            ]
        },
        "reference_to_cardholder_exchange_rate": {
            "type": [
                "number",
                "null"
            ],
            "title": "Reference to cardholder exchange rate",
            "description": "Conversion rate used to convert the local currency purchase to the cardholder currency.",
            "examples": [
                5.23,
                0.0
            ]
        }
    }
}