Transaction created
This event occurs when a transaction is created.
Type: object
Domain: transaction
Event: creation
Version: 1
account_id required
Title: Account ID
Description: ID of the account whose balance is impacted by the transaction
Type: integer
Example:
1
2
accounting_date required
Title: Accounting date
Description: Settlement date (only business days)
Type: string
Format: date
Min length: 1
Max length: 10
Example:
2019-02-04
amount required
Title: Transaction amounts and currencies
Description: Array of transaction amounts and currencies
Type: arraycurrency required
Title: Currency code
Description: ISO 4217 currency code or null if not provided by acquirer
Type: string or null
Min length: 0
Max length: 3
Example:
BRL
USDvalue required
Title: Transaction amount
Description: Numerical value of the transaction
Type: numberdescription
Title: Amount type
Description: Amount type
Type: string or null
Min length: 0
Max length: 50
Example:
TRANSACTION_AMOUNT
LOCAL_AMOUNT
SETTLEMENT_CURRENCY_AMOUNT
authorization required
Title: Authorization
Description: Authorization information
Type: objecttype required
Title: Authorization type
Description: Authorization type
Type: string or null
Min length: 0
Max length: 30
Example:
VISA
MASTERCARD
WALLET
PLATFORMid required
Title: Authorization ID
Description: Authorization unique identifier
Type: integer or null
Example:
1
2tid
Title: External authorization ID
Description: Unique identifier for external authorization
Type: string or null
Min length: 0
Max length: 250
Example:
1231ABcard_id
Title: Card ID
Description: Card unique identifier
Type: string or null
Min length: 0
Max length: 11
Example:
1
2card_hash
Title: Card hash
Description: Hash generated using card PAN (Primary Account Number)
Type: string or null
Min length: 0
Max length: 255
Example:
1231231-123123-1231231authorization_code
Title: Authorization code
Description: Authorization code identifier
Type: string or null
Min length: 0
Max length: 20
Example:
Y0IKQJretrieval_reference_number
Title: Retrieval reference number
Description: Retrieval reference number. Provided by Authorization domain.
Type: string or null
Min length: 0
Max length: 255
Example:
932614326272principal_amount
Title: Principal amount
Description: Principal amount of transaction
Type: number or null
Example:
123.45correlated_authorization_id
Title: Correlated authorization ID
Description: Authorization ID generated by force or installment operations when theoriginal_authorizationfield is provided. See the Force operation and Installments payment guides for more information.
Type: integer or null
Example:
11443744043709851610
10406740073209351312
correlation_id required
Title: Correlation ID
Description: Identifier used to link related API requests and events.
Type: string
Min length: 1
Max length: 75
Example:
3bd713ad-4ffd-93d5-9eaa-2c52f59582e0
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
id required
Title: Transaction ID
Description: Transaction unique identifier
Type: integer
Example:
1
2
3
program required
Title: Program
Description: Program associated with transaction
Type: objectid required
Title: Program ID
Description: Program unique identifier
Type: integer
Example:
1
2name required
Title: Program name
Description: Program name
Type: string
Min length: 1
Max length: 50
Example:
Black Card
Acme Accounttype required
Title: Program type
Description: Program type
Type: string
Min length: 1
Max length: 30
Example:
CREDIT
DEBIT
DIGITAL ACCOUNT
transaction_type required
Title: Transaction type
Description: Transaction type information
Type: objectid required
Title: Transaction type ID
Description: Unique identifier for transation type
Type: integer
Example:
1
2description required
Title: Transaction type description
Description: Description of transaction type
Type: string
Min length: 1
Max length: 30
Example:
COMPRA A VISTA
COMPRA INTERNACIONAL
PARCELADO SEM JUROS
PARCELA SEM JUROS
PARCELADO COM JUROS
PARCELA COM JUROS
SAQUEis_credit required
Title: Is credit
Description: Indicates if the transaction type is a credit (true) or debit (false) operation.
Type: boolean
Min length: 1
Max length: 5statement_post required
Title: Statement post
Description: Indicates if the transaction displays on the account statement.
Type: boolean
Min length: 1
Max length: 5
authorization_tracking_id
Description: Authorization tracking ID
Type: string or null
Min length: 0
Max length: 75
Example:
b7620539-eb50-46a1-aa2c-cc413cace8ab
customer_id
Title: Customer ID
Description: Customer unique identifier
Type: integer or null
Example:
1
2
details
Title: Details
Description: Transaction metadata. This is a JSON object converted to a string.
When creating, updating, or canceling an earmark,corporate_metadatais generated in themetadatafield.corporate_metadataincludes the following subfields:
debit_external_account_id: Identifies the debited account in the creation operation.earmark_id: Indicates the ID of the created earmark.
Type: string or null
Example:
{'test':'test'}
due_date
Title: Due date
Description: Statement due date (ISO 8601)
Type: string or null
Format: date
Min length: 0
Max length: 10
Example:
2019-02-04
installment
Title: Installment number
Description: Number of this installment
Type: integer or null
Example:
1
2
interest_rate
Title: Interest rate
Description: Interest rate on the transaction
Type: number or null
Example:
20.5
null
number_of_installments
Title: Number of installments
Description: Number of installments
Type: integer or null
Example:
4
5
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
Min length: 0
Max length: 75
Example:
MIGRATION
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
processing_code
Title: Processing code
Description: Processing code used to generate the transaction
Type: string or null
Min length: 0
Max length: 6
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
Min length: 0
Max length: 50
Example:
DEBIT PURCHASE
soft_descriptor
Title: Soft descriptor
Description: Temporary description that appears on the statement immediately after a transaction. It's replaced by a permanent billing descriptor after the transaction settles.
Type: string or null
Min length: 0
Max length: 100
Example:
Adjustment made by an operator
statement_id
Title: Statement ID
Description: ID of the statement on which the transaction appears
Type: number or null
Example:
1
955
tax
Title: Tax
Description: Array of one or more taxes applied to transaction amount (nullif no tax)
Type: array or nulltype required
Title: Tax type
Description: Type of tax – IOF, DAILY_IOF, OR INTEREST.
Type: string
Min length: 1
Max length: 20
Must be one of the following:
IOF
DAILY_IOF
INTEREST
Example:
IOFvalue required
Title: Tax value
Description: Amount of tax
Type: number
transaction_group
Title: Transaction group
Description: Transaction group defined by program. This information is in the program transactions types and belongs to the credit cycle domain.
Type: string or null
Min length: 0
Max length: 50
Example:
TAXES_AND_FEES
NATIONAL
INSTALLMENT
user_category
Title: User category
Description: User category. This is provided by the network and comes from the Authorization domain.
Type: string or null
Min length: 0
Max length: 58
Example:
health
sports
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:
20.5
null
rates
Title: Rates
Description: Array of one or more rates applied to transaction amount (nullif no rates)
Type: array or nulltype required
Title: Rates type
Description: Type of rates: settlement_conversion_rate (local currency exchange rate) or reference_to_cardholder_exchange_rate (conversion rate used to convert the local currency purchase to the cardholder currency).
Type: string
Min length: 1
Max length: 30
Must be one of the following:
settlement_conversion_rate
reference_to_cardholder_exchange_rate
Example:
settlement_conversion_ratevalue required
Title: Rate value
Description: Rate value
Type: number
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Transaction created",
"description": "This event occurs when a transaction is created.",
"required": [
"account_id",
"accounting_date",
"amount",
"authorization",
"correlation_id",
"event_date",
"event_datetime",
"id",
"program",
"transaction_type"
],
"properties": {
"account_id": {
"title": "Account ID",
"description": "ID of the account whose balance is impacted by the transaction",
"type": "integer",
"minimum": 1,
"maximum": 4294967295,
"examples": [
1,
2
]
},
"accounting_date": {
"title": "Accounting date",
"description": "Settlement date (only business days)",
"type": "string",
"minLength": 1,
"maxLength": 10,
"format": "date",
"examples": [
"2019-02-04"
]
},
"amount": {
"type": "array",
"title": "Transaction amounts and currencies",
"description": "Array of transaction amounts and currencies",
"items": [
{
"type": "object",
"title": "Transaction amount and currency",
"description": "Represents a transaction amount and its associated currency.",
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"title": "Currency code",
"description": "ISO 4217 currency code or null if not provided by acquirer",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 3,
"examples": [
"BRL",
"USD"
]
},
"value": {
"title": "Transaction amount",
"description": "Numerical value of the transaction",
"type": "number",
"minimum": 0,
"maximum": 18446744073709551617
},
"description": {
"title": "Amount type",
"description": "Amount type",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 50,
"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"
}
]
},
"authorization": {
"type": "object",
"title": "Authorization",
"description": "Authorization information",
"required": [
"type",
"id"
],
"properties": {
"type": {
"title": "Authorization type",
"description": "Authorization type",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 30,
"examples": [
"VISA",
"MASTERCARD",
"WALLET",
"PLATFORM"
]
},
"id": {
"title": "Authorization ID",
"description": "Authorization unique identifier",
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 18446744073709551617,
"examples": [
1,
2
]
},
"tid": {
"title": "External authorization ID",
"description": "Unique identifier for external authorization",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 250,
"examples": [
"1231AB"
]
},
"card_id": {
"title": "Card ID",
"description": "Card unique identifier",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 11,
"examples": [
1,
2
]
},
"card_hash": {
"title": "Card hash",
"description": "Hash generated using card PAN (Primary Account Number)",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 255,
"examples": [
"1231231-123123-1231231"
]
},
"authorization_code": {
"title": "Authorization code",
"description": "Authorization code identifier",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 20,
"examples": [
"Y0IKQJ"
]
},
"retrieval_reference_number": {
"title": "Retrieval reference number",
"description": "Retrieval reference number. Provided by Authorization domain.",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 255,
"example": [
"932614326272"
]
},
"principal_amount": {
"title": "Principal amount",
"description": "Principal amount of transaction",
"type": [
"number",
"null"
],
"minimum": 0,
"maximum": 18446744073709551617,
"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
]
}
}
},
"correlation_id": {
"title": "Correlation ID",
"description": "Identifier used to link related API requests and events.",
"type": "string",
"minLength": 1,
"maxLength": 75,
"examples": [
"3bd713ad-4ffd-93d5-9eaa-2c52f59582e0"
]
},
"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"
]
},
"id": {
"title": "Transaction ID",
"description": "Transaction unique identifier",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
1,
2,
3
]
},
"program": {
"type": "object",
"title": "Program",
"description": "Program associated with transaction",
"required": [
"id",
"name",
"type"
],
"properties": {
"id": {
"title": "Program ID",
"description": "Program unique identifier",
"type": "integer",
"minimum": 1,
"maximum": 4294967295,
"examples": [
1,
2
]
},
"name": {
"title": "Program name",
"description": "Program name",
"type": "string",
"minLength": 1,
"maxLength": 50,
"examples": [
"Black Card",
"Acme Account"
]
},
"type": {
"title": "Program type",
"description": "Program type",
"type": "string",
"minLength": 1,
"maxLength": 30,
"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": {
"title": "Transaction type ID",
"description": "Unique identifier for transation type",
"type": "integer",
"minimum": 1,
"maximum": 4294967295,
"examples": [
1,
2
]
},
"description": {
"title": "Transaction type description",
"description": "Description of transaction type",
"type": "string",
"minLength": 1,
"maxLength": 30,
"examples": [
"COMPRA A VISTA",
"COMPRA INTERNACIONAL",
"PARCELADO SEM JUROS",
"PARCELA SEM JUROS",
"PARCELADO COM JUROS",
"PARCELA COM JUROS",
"SAQUE"
]
},
"is_credit": {
"title": "Is credit",
"description": "Indicates if the transaction type is a credit (`true`) or debit (`false`) operation.",
"type": "boolean",
"minLength": 1,
"maxLength": 5
},
"statement_post": {
"title": "Statement post",
"description": "Indicates if the transaction displays on the account statement.",
"type": "boolean",
"minLength": 1,
"maxLength": 5
}
}
},
"authorization_tracking_id": {
"description": "Authorization tracking ID",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 75,
"examples": [
"b7620539-eb50-46a1-aa2c-cc413cace8ab"
]
},
"customer_id": {
"title": "Customer ID",
"description": "Customer unique identifier",
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 4294967295,
"examples": [
1,
2
]
},
"details": {
"type": [
"string",
"null"
],
"title": "Details",
"description": "Transaction metadata. This is a JSON object converted to a string.\n<br> When creating, updating, or canceling an earmark, `corporate_metadata` is generated in the `metadata` field. `corporate_metadata` includes the following subfields:\n * `debit_external_account_id`: Identifies the debited account in the creation operation.\n * `earmark_id`: Indicates the ID of the created earmark.",
"examples": [
"{'test':'test'}"
]
},
"due_date": {
"title": "Due date",
"description": "Statement due date (ISO 8601)",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 10,
"format": "date",
"examples": [
"2019-02-04"
]
},
"installment": {
"title": "Installment number",
"description": "Number of this installment",
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 4294967295,
"examples": [
1,
2
]
},
"interest_rate": {
"title": "Interest rate",
"description": "Interest rate on the transaction",
"type": [
"number",
"null"
],
"minimum": 0,
"maximum": 18446744073709551617,
"examples": [
20.5,
0.0
]
},
"number_of_installments": {
"title": "Number of installments",
"description": "Number of installments",
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 4294967295,
"examples": [
4,
5
]
},
"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",
"null"
],
"minLength": 0,
"maxLength": 75,
"examples": [
"MIGRATION"
]
},
"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"
]
},
"processing_code": {
"title": "Processing code",
"description": "Processing code used to generate the transaction",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 6,
"examples": [
"PC_123"
]
},
"processing_description": {
"title": "Processing code",
"description": "Description of the processing code. Each code has a pre-defined description.",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 50,
"examples": [
"DEBIT PURCHASE"
]
},
"soft_descriptor": {
"title": "Soft descriptor",
"description": "Temporary description that appears on the statement immediately after a transaction. It's replaced by a permanent billing descriptor after the transaction settles.",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 100,
"examples": [
"Adjustment made by an operator"
]
},
"statement_id": {
"title": "Statement ID",
"description": "ID of the statement on which the transaction appears",
"type": [
"number",
"null"
],
"minimum": 0,
"maximum": 4294967295,
"examples": [
1,
955
]
},
"tax": {
"type": [
"array",
"null"
],
"title": "Tax",
"description": "Array of one or more taxes applied to transaction amount (`null` if no tax)",
"items": [
{
"type": "object",
"title": "Tax item",
"description": "One tax in an array of taxes applied to the transaction",
"required": [
"type",
"value"
],
"properties": {
"type": {
"title": "Tax type",
"description": "Type of tax \u2013 IOF, DAILY_IOF, OR INTEREST.",
"type": "string",
"minLength": 1,
"maxLength": 20,
"enum": [
"IOF",
"DAILY_IOF",
"INTEREST"
],
"examples": [
"IOF"
]
},
"value": {
"title": "Tax value",
"description": "Amount of tax",
"type": "number",
"minimum": 0,
"maximum": 18446744073709551617
}
}
}
],
"examples": [
{
"type": "IOF",
"value": 1.5
},
{
"type": "DAILY_IOF",
"value": 1.99
},
{
"type": "INTEREST",
"value": 0
}
]
},
"transaction_group": {
"title": "Transaction group",
"description": "Transaction group defined by program. This information is in the program transactions types and belongs to the credit cycle domain.",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 50,
"examples": [
"TAXES_AND_FEES",
"NATIONAL",
"INSTALLMENT"
]
},
"user_category": {
"title": "User category",
"description": "User category. This is provided by the network and comes from the Authorization domain.",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 58,
"examples": [
"health",
"sports"
]
},
"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": [
20.5,
0.0
]
},
"rates": {
"type": [
"array",
"null"
],
"title": "Rates",
"description": "Array of one or more rates applied to transaction amount (`null` if no rates)",
"items": [
{
"type": "object",
"title": "Rates item",
"description": "One rate in an array of rates applied to the transaction",
"required": [
"type",
"value"
],
"properties": {
"type": {
"title": "Rates type",
"description": "Type of rates: settlement_conversion_rate (local currency exchange rate) or reference_to_cardholder_exchange_rate (conversion rate used to convert the local currency purchase to the cardholder currency).",
"type": "string",
"minLength": 1,
"maxLength": 30,
"enum": [
"settlement_conversion_rate",
"reference_to_cardholder_exchange_rate"
],
"examples": [
"settlement_conversion_rate"
]
},
"value": {
"title": "Rate value",
"description": "Rate value",
"type": "number",
"minimum": 1,
"maximum": 18446744073709551617
}
}
}
],
"examples": [
{
"type": "settlement_conversion_rate",
"value": 1.0
},
{
"type": "reference_to_cardholder_exchange_rate",
"value": 1.99
}
]
}
}
}
Updated 22 days ago