Authorization timeline event added
Authorization event added to user's timeline. For more information, see Timeline events overview.
Type: object
Domain: timeline
Event: authorization_authorize
Version: 1
id required
Title: Internal authorization ID
Type: integer
Example:
12345678
account_id required
Title: User's account ID at Pismo Platform
Type: integer
Example:
12345678
card_name
Title: Printed name on card
Type: string
Example:
HOMER SIMPSON
card_type
Title: Card type used in authorization
Type: string
Example:
PLASTIC
VIRTUAL
card_id
Title: Card id used in authorization
Type: integer
Example:
12345678
cardholder_currency_rate
Title: Factor used in the conversion from transaction to cardholder billing amount
Type: number
Example:
0.1933263
cardholderbilling_amount required
Title: Indicates the transaction amount in the issuer’s currency
Type: number
Example:
108.711498
contract_amount required
Title: Total amount of the transaction, including all taxes and fees, in the cardholder currency
Type: number
Example:
115.651498
currency_code required
Title: Currency code of the place where the transaction was done. ISO_4217 numeric code
Type: string
Example:
840
986
currency_literal
Title: Currency code country iso code. ISO3166-1 literal 3-digit code
Type: string
Example:
USD
BRL
customer_id required
Title: Customer id used in authorization
Type: integer
Example:
12345678
entry_mode required
Title: Indicates which entry mode code was used in the transaction
Type: string
Example:
01
05
entry_mode_literal
Title: Indicates the name of the entry mode used in the transaction
Type: string
Example:
MANUAL
CHIP
installment_amount required
Title: Installment amount of the authorization
Type: number
Example:
108.711498
installments required
Title: List of installments of this authorization
Type: arrayamount required
Title: Installment amount
Type: number
Example:
108.711498date required
Title: Installment date
Type: string
Example:
2020-01-28
interest_rate required
Title: Contains the rate that the issuer assesses the cardholder for the installment payment
Type: number
Example:
null
is_referral
Title: Indicates whether the transaction is suspected of fraud
Type: boolean
local_amount required
Title: Amount of funds the cardholder requested in the local currency of the acquirer or source location of the transaction
Type: number
Example:
24.99
merchant_category_code required
Title: Identifies the card acceptor that defines the point of the transaction in both local and interchange environments
Type: string
Example:
0000
merchant_category_group
Title: Mapped group based on category code
Type: string
Example:
RETAIL
merchant_city
Title: City field from merchant
Type: string
Example:
NEW YORK
merchant_state_or_country
Title: State or country field from merchant
Type: string
Example:
USA
tid
Title: Transaction identifier received on the authorization message.
Description: This identifier is generated by the Card Network. It will be null in case where the card network doesn't send this value.
Type: string or null
Example:
10119031908214800419
10219040207333200054
network required
Title: Network brand name
Type: string
Example:
Mastercard
Visa
number_of_installments required
Title: Number of installments in authorization
Type: integer
Example:
1
10
12
org_operation required
Title: Includes the processing code of the authorization
Type: objectprocessing_code required
Title: Describes the effect of a transaction on the customer account and the type of accounts affected
Type: string
Example:
000000
pre_authorization required
Title: Define whether it is a pre-authorization request or not
Type: boolean
Example:
true
principal_amount required
Title: Amount of transaction without taxes and fees
Type: number
Example:
108.711498
response_code required
Title: Defines the disposition of a previous message or an action taken as a result of receipt of a previous message
Type: string
Example:
00
settlement_currency_amount
Title: Amount of funds to be transferred between the acquirer and the issuer equal to the transaction amount in the settlement currency
Type: number
Example:
24.99
settlement_currency_code
Title: Currency code defined by the issuer
Type: string or null
Example:
840
986
settlement_currency_literal
Title: Currency code country description for settlement
Type: string or null
Example:
USD
BRL
settlement_currency_rate
Title: Factor used in the conversion from transaction to settlement amount
Type: number
Example:
0.1955
soft_descriptor
Title: Merchant description including name, city and country code
Type: string
Example:
MOE'S BAR
to_name
Type: string
Example:
MOE'S BAR
nsu
Title: Message initiator assigns to uniquely identify a transaction
Type: string
Example:
000001
retrieval_reference_number
Title: Document reference number assigned by the acquirer
Type: string
Example:
085000100001
authorization_code
Title: Transaction response ID code assigned by authorizing institution
Type: string
Example:
ABC123
ledger_update_id
Title: Id of update performed on Ledger API
Description: Id returned by the Ledger API which identifies the account limit impact. This field may be null since some transactions generate timeline but doesn't have any financial impact.
Type: string or null
Example:
dc123453-4444-1111-9999-53699d123456
card_acceptor_id
Title: Identifies the card acceptor that defines the point of the transaction in both local and interchange environments
Type: string
Example:
013335009996001
airport_tax
Title: Amount of airport tax on the authorization
Type: number or null
Example:
109.14
cash_back_amount
Title: Amount of Cash Back of the Authorization
Description: In purchase with cash back or POS withdrawal, this is the amount related to the withdrawal/cash back. The principal amount is the sum of this amount with the purchase amount.
Type: number
Example:
200
token_information
Title: Token information for tokenized authorizations
Description: Contains information of the token which did authenticate authorization
Type: object or nullid
Title: Token ID
Description: The sequential internal identifier that is generated automatically
Type: null or integer
Example:
17084
17085requestor_id
Title: Requestor ID
Description: A string that identifies the wallet which request the token provisioning
Type: null or string
Example:
APPLE_PAY
GOOGLE_PAYtype
Title: Token Type
Description: A string that identifies the type of the token
Type: null or string
Example:
CARD_ON_FILE
EMBEDDED_SECURE_ELEMENTnetwork_token
Title: Network Token
Description: Token identifier as coming from the network. For Visa requests, this field represents the value received in the F123, Usage 2, Dataset ID 68 (Token Data), Tag 01. For Mastercard requests, it is DE48, SE 33 PanMappingFileInformation, SF2 Account Number.
Type: null or string
Example:
17084
17085network_requestor_id
Title: Network Requestor ID
Description: A string that identifies the wallet which request the token provisioning, as coming from the network. For Visa requests, this field represents the value received in the F123, Usage 2, Dataset ID 68 (Token Data), Tag 03. For Mastercard requests, it is DE48, SE 33 PanMappingFileInformation, SF6 Token Requestor ID.
Type: null or string
Example:
40010043095
40010083219
mti
Title: Message Type Identifier
Description: Indicates the type of message.
Type: string
Example:
0100
cancelled_by_elapsed_time
Title: Cancelled by Elapsed Time
Description: This flag indicates whether a authorization was cancelled because of the elapsed time without a confirmation message. If so, its value will be 'true'. If the authorization was cancelled by the acquirer, its value will be false. For events other than Cancellation timelines, its value will be 'null'.
Type: boolean or null
Example:
true
false
null
metadata
Title: Metadata from Anti Fraud
Description: Contains any valid json sent into the response of the Anti Fraud request. This information is saved and sent into this event as it was received into the platform, without any processing over it.
Type: object or null
validation_results
Type: array or null
Additional properties: falsename required
Title: Validation name
Description: The name which identifies the validation.
Type: string
Example:
CVV2_INVALID
EXPIRATION_DATE_INVALID
ARQC_SIGNATURE_VALIDstatus required
Title: Validation status
Description: Represents the result of the validation.
Type: string
Must be one of the following:
SKIPPED
APPROVED
REJECTEDreason required
Title: Validation reason
Description: Identifies the reason why a validation has that result.
Type: null or string
Example:
TERMINAL_CAPABILITY_VALID
PIN_AND_CVV_VALIDdescription required
Title: Description
Description: Contains a more detailed information about the validation result.
Type: string
Example:
TERMINAL_CAPABILITY_VALID
PIN_AND_CVV_VALIDadditional_data
Title: Additional Data
Description: Contains additional information that is relevant to identify how the validation was performed. Every validation will have its own additional data, so please refer to Pismo Developers Guide to identify every possibility.
Type: object or null
dcc
Title: Flag indicating a DCC authorization
Description: This flag identifies if an authorization is DCC. This flag is true when the local amount is in the cardholder currency but the Merchant is International. It identifies that even though the authorization is in the local currency, it was considered an International authorization.
Type: boolean or null
Example:
true
false
null
incoming_response_code
Title: Incoming Response Code from Card Network
Description: This field represents the value received in the field 39 of the Card Network specification and indicates the Response Code they assigned to this authorization. For cancellation messages, if present, this value may indicate the reason of the cancellation.
Type: string or null
Example:
00
05
incoming_authorization_code
Title: Incoming Authorization Code from Card Network
Description: This field represents the value received in the field 38 of the Card Network specification and indicates the Authorization Code they assigned to this authorization.
Type: string or null
Example:
00
05
origin
Description: The origin used in migrations.
Type: string
Example:
STRIKER
MIGRATION
null
program_id
Title: Program ID used in the authorization.
Description: This field represents the internal id of the Program of the card used on this authorization.
Type: integer
Example:
82
93
131
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Authorization timeline event added",
"description": "Authorization event added to user's timeline. For more information, see [Timeline events overview](https://developers.pismo.io/pismo-docs/docs/timeline-overview).",
"required": [
"id",
"account_id",
"cardholderbilling_amount",
"contract_amount",
"currency_code",
"customer_id",
"entry_mode",
"installment_amount",
"installments",
"interest_rate",
"local_amount",
"merchant_category_code",
"network",
"number_of_installments",
"org_operation",
"pre_authorization",
"principal_amount",
"response_code"
],
"properties": {
"id": {
"type": "integer",
"title": "Internal authorization ID",
"examples": [
12345678
]
},
"account_id": {
"type": "integer",
"title": "User's account ID at Pismo Platform",
"default": 0,
"examples": [
12345678
]
},
"card_name": {
"type": "string",
"title": "Printed name on card",
"examples": [
"HOMER SIMPSON"
]
},
"card_type": {
"type": "string",
"title": "Card type used in authorization",
"examples": [
"PLASTIC",
"VIRTUAL"
]
},
"card_id": {
"type": "integer",
"title": "Card id used in authorization",
"examples": [
12345678
]
},
"cardholder_currency_rate": {
"type": "number",
"title": "Factor used in the conversion from transaction to cardholder billing amount",
"examples": [
0.1933263
]
},
"cardholderbilling_amount": {
"type": "number",
"title": "Indicates the transaction amount in the issuer\u2019s currency",
"examples": [
108.711498
]
},
"contract_amount": {
"type": "number",
"title": "Total amount of the transaction, including all taxes and fees, in the cardholder currency",
"examples": [
115.651498
]
},
"currency_code": {
"type": "string",
"title": "Currency code of the place where the transaction was done. ISO_4217 numeric code",
"examples": [
"840",
"986"
]
},
"currency_literal": {
"type": "string",
"title": "Currency code country iso code. ISO3166-1 literal 3-digit code",
"examples": [
"USD",
"BRL"
]
},
"customer_id": {
"type": "integer",
"title": "Customer id used in authorization",
"examples": [
12345678
]
},
"entry_mode": {
"type": "string",
"title": "Indicates which entry mode code was used in the transaction",
"examples": [
"01",
"05"
]
},
"entry_mode_literal": {
"type": "string",
"title": "Indicates the name of the entry mode used in the transaction",
"examples": [
"MANUAL",
"CHIP"
]
},
"installment_amount": {
"type": "number",
"title": "Installment amount of the authorization",
"examples": [
108.711498
]
},
"installments": {
"type": "array",
"title": "List of installments of this authorization",
"items": {
"type": "object",
"title": "Installment information",
"required": [
"amount",
"date"
],
"properties": {
"amount": {
"type": "number",
"title": "Installment amount",
"examples": [
108.711498
]
},
"date": {
"type": "string",
"title": "Installment date",
"examples": [
"2020-01-28"
]
}
}
}
},
"interest_rate": {
"type": "number",
"title": "Contains the rate that the issuer assesses the cardholder for the installment payment",
"examples": [
0
]
},
"is_referral": {
"type": "boolean",
"title": "Indicates whether the transaction is suspected of fraud"
},
"local_amount": {
"type": "number",
"title": "Amount of funds the cardholder requested in the local currency of the acquirer or source location of the transaction",
"examples": [
24.99
]
},
"merchant_category_code": {
"type": "string",
"title": "Identifies the card acceptor that defines the point of the transaction in both local and interchange environments",
"examples": [
"0000"
]
},
"merchant_category_group": {
"type": "string",
"title": "Mapped group based on category code",
"examples": [
"RETAIL"
]
},
"merchant_city": {
"type": "string",
"title": "City field from merchant",
"examples": [
"NEW YORK"
]
},
"merchant_state_or_country": {
"type": "string",
"title": "State or country field from merchant",
"examples": [
"USA"
]
},
"tid": {
"type": [
"string",
"null"
],
"title": "Transaction identifier received on the authorization message.",
"description": "This identifier is generated by the Card Network. It will be null in case where the card network doesn't send this value.",
"examples": [
"10119031908214800419",
"10219040207333200054"
]
},
"network": {
"type": "string",
"title": "Network brand name",
"examples": [
"Mastercard",
"Visa"
]
},
"number_of_installments": {
"type": "integer",
"title": "Number of installments in authorization",
"examples": [
1,
10,
12
]
},
"org_operation": {
"type": "object",
"title": "Includes the processing code of the authorization",
"required": [
"processing_code"
],
"properties": {
"processing_code": {
"type": "string",
"title": "Describes the effect of a transaction on the customer account and the type of accounts affected",
"examples": [
"000000"
]
}
}
},
"pre_authorization": {
"type": "boolean",
"title": "Define whether it is a pre-authorization request or not",
"examples": [
true
]
},
"principal_amount": {
"type": "number",
"title": "Amount of transaction without taxes and fees",
"examples": [
108.711498
]
},
"response_code": {
"type": "string",
"title": "Defines the disposition of a previous message or an action taken as a result of receipt of a previous message",
"examples": [
"00"
]
},
"settlement_currency_amount": {
"type": "number",
"title": "Amount of funds to be transferred between the acquirer and the issuer equal to the transaction amount in the settlement currency",
"examples": [
24.99
]
},
"settlement_currency_code": {
"type": [
"string",
"null"
],
"title": "Currency code defined by the issuer",
"examples": [
"840",
"986"
]
},
"settlement_currency_literal": {
"type": [
"string",
"null"
],
"title": "Currency code country description for settlement",
"examples": [
"USD",
"BRL"
]
},
"settlement_currency_rate": {
"type": "number",
"title": "Factor used in the conversion from transaction to settlement amount",
"examples": [
0.1955
]
},
"soft_descriptor": {
"type": "string",
"title": "Merchant description including name, city and country code",
"examples": [
"MOE'S BAR "
]
},
"to_name": {
"type": "string",
"title": "",
"examples": [
"MOE'S BAR"
]
},
"nsu": {
"type": "string",
"title": "Message initiator assigns to uniquely identify a transaction",
"examples": [
"000001"
]
},
"retrieval_reference_number": {
"type": "string",
"title": "Document reference number assigned by the acquirer",
"examples": [
"085000100001"
]
},
"authorization_code": {
"type": "string",
"title": "Transaction response ID code assigned by authorizing institution",
"examples": [
"ABC123"
]
},
"ledger_update_id": {
"type": [
"string",
"null"
],
"title": "Id of update performed on Ledger API",
"description": "Id returned by the Ledger API which identifies the account limit impact. This field may be null since some transactions generate timeline but doesn't have any financial impact.",
"examples": [
"dc123453-4444-1111-9999-53699d123456"
]
},
"card_acceptor_id": {
"type": "string",
"title": "Identifies the card acceptor that defines the point of the transaction in both local and interchange environments",
"examples": [
"013335009996001"
]
},
"airport_tax": {
"type": [
"number",
"null"
],
"title": "Amount of airport tax on the authorization",
"examples": [
109.14
]
},
"cash_back_amount": {
"type": "number",
"title": "Amount of Cash Back of the Authorization",
"description": "In purchase with cash back or POS withdrawal, this is the amount related to the withdrawal/cash back. The principal amount is the sum of this amount with the purchase amount.",
"examples": [
200
]
},
"token_information": {
"type": [
"object",
"null"
],
"title": "Token information for tokenized authorizations",
"description": "Contains information of the token which did authenticate authorization",
"properties": {
"id": {
"type": [
"null",
"integer"
],
"title": "Token ID",
"description": "The sequential internal identifier that is generated automatically",
"examples": [
17084,
17085
]
},
"requestor_id": {
"type": [
"null",
"string"
],
"title": "Requestor ID",
"description": "A string that identifies the wallet which request the token provisioning",
"examples": [
"APPLE_PAY",
"GOOGLE_PAY"
]
},
"type": {
"type": [
"null",
"string"
],
"title": "Token Type",
"description": "A string that identifies the type of the token",
"examples": [
"CARD_ON_FILE",
"EMBEDDED_SECURE_ELEMENT"
]
},
"network_token": {
"type": [
"null",
"string"
],
"title": "Network Token",
"description": "Token identifier as coming from the network. For Visa requests, this field represents the value received in the F123, Usage 2, Dataset ID 68 (Token Data), Tag 01. For Mastercard requests, it is DE48, SE 33 PanMappingFileInformation, SF2 Account Number.",
"examples": [
"17084",
"17085"
]
},
"network_requestor_id": {
"type": [
"null",
"string"
],
"title": "Network Requestor ID",
"description": "A string that identifies the wallet which request the token provisioning, as coming from the network. For Visa requests, this field represents the value received in the F123, Usage 2, Dataset ID 68 (Token Data), Tag 03. For Mastercard requests, it is DE48, SE 33 PanMappingFileInformation, SF6 Token Requestor ID.",
"examples": [
"40010043095",
"40010083219"
]
}
}
},
"mti": {
"type": "string",
"title": "Message Type Identifier",
"description": "Indicates the type of message.",
"examples": [
"0100"
]
},
"cancelled_by_elapsed_time": {
"type": [
"boolean",
"null"
],
"title": "Cancelled by Elapsed Time",
"description": "This flag indicates whether a authorization was cancelled because of the elapsed time without a confirmation message. If so, its value will be 'true'. If the authorization was cancelled by the acquirer, its value will be false. For events other than Cancellation timelines, its value will be 'null'.",
"examples": [
true,
false,
null
]
},
"metadata": {
"title": "Metadata from Anti Fraud",
"description": "Contains any valid json sent into the response of the Anti Fraud request. This information is saved and sent into this event as it was received into the platform, without any processing over it.",
"type": [
"object",
"null"
]
},
"validation_results": {
"title": "Validation results",
"description": "Contains all executed validations with details for each result.",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Validation name",
"description": "The name which identifies the validation.",
"type": [
"string"
],
"examples": [
"CVV2_INVALID",
"EXPIRATION_DATE_INVALID",
"ARQC_SIGNATURE_VALID"
]
},
"status": {
"title": "Validation status",
"description": "Represents the result of the validation.",
"type": [
"string"
],
"enum": [
"SKIPPED",
"APPROVED",
"REJECTED"
]
},
"reason": {
"title": "Validation reason",
"description": "Identifies the reason why a validation has that result.",
"type": [
"null",
"string"
],
"examples": [
"TERMINAL_CAPABILITY_VALID",
"PIN_AND_CVV_VALID"
]
},
"description": {
"title": "Description",
"description": "Contains a more detailed information about the validation result.",
"type": [
"string"
],
"examples": [
"TERMINAL_CAPABILITY_VALID",
"PIN_AND_CVV_VALID"
]
},
"additional_data": {
"title": "Additional Data",
"description": "Contains additional information that is relevant to identify how the validation was performed. Every validation will have its own additional data, so please refer to Pismo Developers Guide to identify every possibility.",
"type": [
"object",
"null"
]
}
},
"required": [
"name",
"status",
"reason",
"description"
]
}
},
"dcc": {
"type": [
"boolean",
"null"
],
"title": "Flag indicating a DCC authorization",
"description": "This flag identifies if an authorization is DCC. This flag is true when the local amount is in the cardholder currency but the Merchant is International. It identifies that even though the authorization is in the local currency, it was considered an International authorization.",
"examples": [
true,
false,
null
]
},
"incoming_response_code": {
"type": [
"string",
"null"
],
"title": "Incoming Response Code from Card Network",
"description": "This field represents the value received in the field 39 of the Card Network specification and indicates the Response Code they assigned to this authorization. For cancellation messages, if present, this value may indicate the reason of the cancellation.",
"examples": [
"00",
"05"
]
},
"incoming_authorization_code": {
"type": [
"string",
"null"
],
"title": "Incoming Authorization Code from Card Network",
"description": "This field represents the value received in the field 38 of the Card Network specification and indicates the Authorization Code they assigned to this authorization.",
"examples": [
"00",
"05"
]
},
"origin": {
"type": "string",
"description": "The origin used in migrations.",
"examples": [
"STRIKER",
"MIGRATION",
"null"
]
},
"program_id": {
"type": "integer",
"title": "Program ID used in the authorization.",
"description": "This field represents the internal id of the Program of the card used on this authorization.",
"examples": [
82,
93,
131
]
}
},
"definitions": {}
}
Updated 5 days ago