Network authorization received
This event represents an authorization action. All actions (authorization, decline, confirmation, cancellation, partial cancellation. and so on) generate this event. Pismo issues this event after the message from the network is processed and a decision is made about the action to take. For more information, see the Authorization events guide. Also see Linking events in an authorization.
Type: object
Domain: networktransactions
Event: network-authorization
Version: 1
authorization_category required
Title: Event category
Description: Category of authorization generating this event
Type: string
Must be one of the following:
AUTHORIZATION
CONFIRMATION
DECLINED
CANCELLATION
PARTIAL_CANCELLATION
INSTALLMENT
AIRPORT_TAX
REPLACEMENT
INCREMENTAL
CANCELLATION_REVERSAL
REVERSAL_PARTIAL_CANCELLATION
authorization_type required
Title: Authorization type
Description: Type of authorization. Currently, this event is only issued for authorizations coming from the Card Network, so this field is a constant value.
Constant:NETWORK
org_id required
Title: Org/tenant ID
Description: Pismo organization/tenant ID
Type: string
Example:
TN-99999999-1234-4321-5678-123456789012
account_id
Title: Account ID
Description: Pismo account ID. This information is fetched using the Card used in the authorization. If no card is found, this information will not be present in the DECLINED event.
Type: integer or null
Example:
15500
1000
acquirer_bin
Title: Acquirer Identifier
Description: Identifies the acquiring institution (for example, merchant bank) or its agent. This field represents the value received in field 32 of the Card Network Specification.
Type: string or null
Example:
12345
advice_detail_code
Title: Advice detail code
Description: Identifies the detail why the card network issued this advice. This field is only used for Mastercard requests and it represents the value received in the DE60 subfield 2 of the specification, if it is present in the card network message.
Type: string or null
Example:
0043
0045
advice_reason_code
Title: Advice reason code
Description: Why the card network issued this advice. For messages other than advices, this field is null. In Mastercard requests this field represents the value received in the DE60 subfield 1 of the specification. For Visa requests, this field represents the value received in the F63.4 of the specification.
Type: string or null
Example:
120
9020
airport_tax
Title: Airport tax amount
Description: Calculated airport tax amount in the cardholder's currency, received in confirmation messages for transactions of this type. The value will be null for confirmations that do not have airport tax included.
Type: number or null
Example:
100.0
anti_fraud_execution_time
Title: Anti-fraud API response time
Description: Time in milliseconds between the anti-fraud API call and its response
Type: integer or null
Example:
2000
156
anti_fraud_url
Description: Anti-Fraud API URL configured per Interbank Card Association (ICA) member.
Type: string or null
Example:
our.antifraud.customer/my/path
arqc_present
Title: ARQC present flag
Description: Authorization Request Cryptogram. Indicates whether the authorization request was performed and the cryptogram information (field 55 of the Card Network specification) was present in the message.
Type: boolean or null
Example:
true
atc
Title: Application transaction counter
Description: The ATC (application transaction counter) is a counter, maintained by the chip card application (incremented by the chip), that provides a sequential reference to each transaction. This field is the ATC value for this card on this authorization. Only authorization requests with cryptogram information contain this counter.
Type: integer or null
Example:
100
null
authorization_code
Title: Authorization request authorization code
Description: An alphanumeric 6-digit code generated for an authorization request that can be used to relate this event to other events associated with the same authorization. For more information, see the Linking authorization events guide.
Type: string or null
Example:
ABC123
authorization_date_hour
Title: Authorization UTC-3 date/time
Description: Request UTC-3 date and time - when the platform received the request from the network. No field in the Card Network message is considered.
Type: string or null
Format: date-time
Example:
2020-01-01T10:10:00
authorization_id
Title: Authorization unique ID
Description: Authorization internal ID. This ID is unique and must be the same in all events related to the same authorization. It can be used to relate the current event with other events of the same authorization. For more information, see the Linking authorization events guide.
Type: integer or null
Example:
100000
125677
authorization_response_code
Title: Authorization response code
Description: Response code the authorization platform assigns to the authorization request. Indicates whether it was declined or not.
Type: string
Example:
00
14
authorization_status
Title: Authorization status
Description: Authorization internal status code. Current authorization status for the action which issued this event. (1- Pending, 2- Confirmed, 3- Declined, 4- Cancelled, 5- Dropped).
Type: integer
Must be one of the following:
1
2
3
4
5
authorization_url
Title: Authorization URL
Description: Authorization API URL configured per program. Present when core-banking operations are made in our client's side.
Type: string or null
Example:
our.authorization.customer/my/path
caller
Title: Card network
Description: Card network generating the authorization request.
Type: string
Example:
Mastercard
Visa
tecban
cancelled_by_elapsed_time
Title: Cancelled by elapsed time flag
Description: Was an authorization cancelled due to elapsed time without a confirmation message flag.
Type: boolean
Example:
true
false
card_acceptor_id
Title: Card acceptor ID
Description: Identifies the card acceptor defining the transaction point in both local and interchange environments. This field represents the value received in field 42 of the Card Network Specification.
Type: string or null
Example:
000055551111009
card_id
Title: Card ID
Description: Pismo card ID. If no card is found, based on the PAN received, this information will not be present in the DECLINED event.
Type: integer or null
Example:
10222
8899
cardholder_currency_code
Title: Currency Code of the Cardholder
Description: Cardholder ISO4217 currency code for currency used to bill the account. The final authorization amount is calculated in this currency.
Type: string or null
Example:
986
cardholder_currency_code_literal
Title: Currency Code of the Cardholder as Literal
Description: Field represent Cardholder ISO4217 currency code for currency used to bill the account as literal.
Type: string or null
Example:
BRL
cid required
Title: Authorizaton correlation ID
Description: Authorization correlation ID . Along with theauthorization_id
, you can use this field to relate it to other events associated with this authorization. For more information, see the Linking authorization events guide.
Type: string
Example:
dc123453-4444-1111-9999-53699d123456
conciliation_information
Title: Conciliation information
Description: Information regarding the conciliation message being processed for this authorization.
Type: object or nullacquirer_reference_number
Title: Acquirer reference number
Description: Acquirer-supplied data in an acquirer-originated message. An issuer may be required to return this data in a subsequent message to the acquirer.
Type: string or null
Example:
22223021032000000000680
installment_number
Title: Installment current number
Description: Indicates the installment number in the concilation message being processed.
Type: number or null
Example:
2
10
interchange_fee_amount
Title: Interchange fee amount
Description: Interchange fee amount received in the conciliation message. Every time a retailer processes a credit card or debit card payment, the merchant pays an interchange fee. This fee, often called a 'swipe fee,' is designed to cover the costs associated with accepting, processing and authorizing card transactions.
Type: number or null
Example:
0.0082
1.1657
interchange_fee_indicator
Title: Credit or debit fee indicator
Description: Indicates if the interchange fee amount is a debit or a credit.
Type: string or null
Must be one of the following:
CREDIT
DEBIT
NOT_APPLICABLE
message_number
Title: Conciliation message number
Description: Card network assigned number in the conciliation file for this conciliation message.
Type: string or null
Example:
9920
0001
processing_julian_date
Title: Assigned Julian date
Description: Julian processing date the acquirer assigns to the First Presentment/1240 in the format YDDD.
Type: string or null
Example:
0350
1220
conciliation_type
Title: Program conciliation type
Description: Type of conciliation used for this authorization. Single message for authorizations which create transactions from Base I messages, Dual message for authorizations which create transactions from Base II messages.
Type: string
Must be one of the following:
SINGLE_MESSAGE
DUAL_MESSAGE
UNDEFINED
contract_amount
Title: Authorization contract amount
Description: Calculated authorization amount, including taxes or fees, in the cardholder's currency. For Declined transactions this field may be null, since no calculation was performed.
Type: number or null
Example:
110.0
created_from_authorization_not_found
Title: Created from authorization not found flag
Description: Indicates whether an authorization was created in the clearing flow for scenarios where we didn't find a corresponding Base1 Authorization.
Type: boolean
Example:
true
false
custom_response_code
Title: Internal denial Code
Description: Internal custom code generated in authorization flow for declined requests. Indicates the reason the request was declined. For more information, see the Validation codes for authorization events guide
Type: string or null
Example:
BND
810
FR2
merchant_denial_code
Title: Merchant denial code
Description: This code communicates the reason for declining the authorization and the course of action that merchants can take. The code depends on the card network. For example, Mastercard uses Merchant Advice Code (MAC) and Visa uses Recurring Payment Cancellation (RPC).
Type: string or null
Example:
02
03
customer_id
Title: Customer ID
Description: ID of customer holding card used in this authorization. If no card is found, this information will be null in the DECLINED event.
Type: integer or null
Example:
10222
8899
cvv_present
Title: CVV present flag
Description: Indicates whether the authorization request was performed and the card's CVV (card verification value) was present.
Type: boolean or null
Example:
true
false
event_date_hour
Title: Received message date/time
Description: Date and time Network/Acquirer message received. This field represents the value contained in fields 12 (Time) and 13 (Date) of the Card Network Specification. If these values are present, they are used without validations and since the network only sends the day and month, the current year is assumed. If they are not present, the current time of the authorization is used (UTC-3).
Type: string or null
Format: date-time
Example:
2020-01-01T10:10:00
event_date_hour_utc
Title: DateTime in UTC
Description: Authorization UTC date and time. This field considers the time when the platform received the request from the Network to define its value. No field in the Card Network message is considered.
Type: string or null
Format: date-time
Example:
2020-01-01T10:10:00Z
file_date
Title: File processing date
Description: Date when issuer processed the Base II file.
Type: string or null
Example:
2020-01-01
incoming_authorization_code
Title: Authorization code
Description: Authorization code from the card network in field 38 of the message request. If the request was approved in the Stand-In flow, this field indicates the authorization code assigned to this message.
Type: string or null
Example:
ABC123
123456
incoming_response_code
Title: Network response code
Description: Any response code from the Card Network in field 39 of the message request. It indicates whether the request was approved in the Stand-In flow.
Type: string or null
Example:
0043
0045
installment_amount
Title: Calculated authorization installment amount
Description: Calculated amount of each installment in the authorization in the cardholder's currency. For authorizations without installments, this field will be the same as the total authorization amount. For Declined transactions this field may be null, since no calculation was performed.
Type: number or null
Example:
55.0
installments_information
Type: array or null
Additional properties: falseinstallment_amount
Title: Total installment amount
Description: Calculated total amount for all installments.
Type: number
Example:
100.0
number
Title: Installment number
Description: Identifies which installment this object is about.
Type: number
Example:
1
2
3
postings
Title: Installment fees and taxes.
Description: Taxes and fees calculated for this installment.
Type: object or nullamortization
Title: Installment amortization amount
Description: Calculated amortization amount for this installment when calculating a purchase with installments and interest.
Type: number
Example:
10.0
daily_iof_amount
Title: Daily IOF (Brazilian tax) amount
Description: Calculated installment's daily IOF (Brazilian tax) amount in the cardholder's currency.
Type: number
Example:
0.45
fixed_iof_amount
Title: Fixed IOF (Brazilian tax) amount
Description: Calculated installment's daily fixed IOF (Brazilian tax) in the cardholder's currency. The calculated fixed amount is always set to the first installment.
Type: number
Example:
0.78
interest_amount
Title: Interest amount
Description: Calculated installment interest in the cardholder's currency.
Type: number
Example:
1.37
iof_amount
Title: IOF (Brazilian tax) amount
Description: Calculated installment IOF (Brazilian tax) in the cardholder's currency. This field sums the installment's daily and fixed IOF amount
Type: number
Example:
0.45
labels
Type: array or null
Must be one of the following:[ "DCC", "INCREMENT_ATC", "INCREMENT_PASSWORD_TRIES", "INCREMENT_NUMBER_OF_TRANSACTIONS", "BLOCK_CARD", "CLEAR_PASSWORD_TRIES" ]
ledger_update_id
Title: Ledger update ID
Description: ID from Ledger API indicating the account limit impact. This field may be null since some authorizations don't have any financial impact.
Type: string or null
Example:
dc123453-4444-1111-9999-53699d123456
local_amount
Title: Authorization local amount
Description: Amount in local currency where the authorization was requested. The value received in field 4 of the Card Network Specification.
Type: number or null
Example:
100.0
local_currency_code
Title: Local amount currency code
Description: Currency code of the place where the authorization was requested. The value received in field 49 of the Card Network Specification.
Type: string or null
Example:
986
840
local_currency_code_literal
Title: Local amount currency code as literal
Description: Currency code of the place where the authorization was requested as literal.
Type: string or null
Example:
BRL
USD
merchant_category_id
Title: Merchant category code
Description: Merchant category code based on the merchant's type of business or service. This field represents the value received in field 18 of the Card Network Specification.
Type: string or null
Example:
5199
3040
merchant_city
Title: Card acceptor (merchant) city
Description: Merchant's city. This field represents the value received in field 43, subfield 2, of the Card Network Specification.
Type: string or null
Example:
Sao Paulo
merchant_name
Title: Card acceptor (merchant) name
Description: Merchant's 'doing business as' name. This field represents the value received in field 43, subfield 1, of the Card Network Specification.
Type: string or null
Example:
Acme Dry Goods
merchant_state_or_country
Title: Card acceptor (merchant) country/state
Description: Merchant's country/state. This field represents the value received in field 43, subfield 3, of the Card Network Specification.
Type: string or null
Example:
BRA
merchant_zip_code
Title: Card acceptor (merchant) postal code
Description: Postal code of merchant where the transaction took place.
Type: string or null
Example:
12345999
metadata
Title: Anti-fraud metadata
Description: Any valid JSON sent in the response from the anti-fraud request. This information is saved and sent in this event as it was received by the platform, without any further processing.
Type: object or null
mti
Title: Message type indicator
Description: Message type indicator - Card Network request type. Can be used to identify whether the request is an Advice (Standin flow) or not. For more information, see MTI
Type: string
Example:
0100
0120
nsu
Title: Message initiator ID
Description: Message initiator assigned ID that uniquely identifies a transaction. This field contains the value received in the authorization message in field 11 of the Card Network Specification.
Type: string or null
Example:
999000
number_of_installments
Title: Authorization number of installments
Description: In purchases with installments, this field represents the number of installments for which the authorization was requested. For any operation other than purchase with installments, this value should be 1.
Type: integer or null
Example:
3
org_operation_id
Title: Operation unique ID
Description: Internal identifier of the operation performed on this authorization. This information is related to the Processing Code (field 3 in the Card Network Specification) of the authorization. If the Operation is not allowed for that program or the Processing Code is not mapped, this field will not be present in the DECLINED event.
Type: integer or null
Example:
10
145
origin
Title: Transaction origin
Description: Identifies where one transaction was issued, if it is from STRIKER('Rebatedor') or migrated from historical data
Type: string or null
Must be one of the following:
STRIKER
MIGRATION
original_authorization_date_hour
Title: Original authorization UTC-3 date/time
Description: UTC-3 sate and time of the original authorization. Indicates the time when the platform received the request that creates the authorization from the Network. No field in the Card Network message is considered. If this is the authorization request, the value of this field will be the same as theauthorization_date_hour
. For other requests such as cancellation and confirmation, this field's value will be the date when the authorization was first requested.
Type: string
Format: date-time
Example:
2020-01-01T10:10:00
original_event_date_hour_utc
Title: Original authorization UTC-0 date/timeDate
Description: UTC-0 date and time of the original authorization. Indicates when the platform received the request that creates the authorization from the network. No field in the Card Network message is considered. If this is the authorization request, the value of this field will be the same as theevent_date_hour_utc
. For other requests such as cancellation and confirmation, the value of this field will be the date when the authorization was first requested.
Type: string
Format: date-time
Example:
2020-01-01T10:10:00Z
pan
Title: Primary account number hash
Description: Hashed PAN (Primary Account Number). This hash is generated from the PAN and is unique inside the platform. You can use it to identify a card together with thecard_id
field.
Type: string or null
Example:
nabcdef5432111abcde6543217abcdefGHHHZZZZfGZ119292999g==
password_present
Title: Password present flag
Description: Indicates whether the authorization request was performed and the card's password is present.
Type: boolean or null
Example:
true
false
point_of_sale
Title: Point of sale (POS) information
Description: Information regarding the POS.
Type: object or nullentry_mode
Title: Authorization entry mode
Description: The method used for PAN entry to initiate a transaction and the PIN entry capabilities. This field represents the value received in field 22 of the Card Network Specification.
Type: string
Example:
010
051
postings
Description: Authorization taxes and fees.
Type: object or nullcash_back_amount
Title: Cash back amount
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.0
fee_amount
Title: Fee amount
Description: Calculated fee for this authorization in the cardholder's currency.
Type: number
Example:
15.0
interest_amount
Title: Interest rate
Description: Calculated amount of interest rate for this authorization in the cardholder's currency.
Type: number
Example:
10.0
iof_amount
Title: IOF amount
Description: Calculated amount of IOF (Brazilian tax) for this authorization in the cardholder's currency.
Type: number
Example:
6.38
purchase_amount
Title: Purchase amount
Description: In a purchase with cash back or POS withdrawal, this is the amount related to the purchase itself. The principal amount is the sum of this amount with the cash back amount.
Type: number
Example:
200.0
principal_amount
Title: Principal authorization amount
Description: Calculated amount of the authorization without taxes or fees in the cardholder's currency. For Declined transactions this field may be null, since no calculation was performed.
Type: number or null
Example:
100.0
processing_code
Title: Processing code
Description: Type of request being processed, like purchase, withdrawal, purchase with installments, credit return and so on. See Processing codes and transaction types for more information
Type: string
Example:
00
01
program_id
Title: Program ID
Description: Internal identifier of the card's program used for this authorization. If no card is found, this information will not be present in the DECLINED event.
Type: integer or null
Example:
100
500
rates
Description: Contains the rates used to calculate the amounts of this authorization.
Type: object or nullcardholder_conversion_rate
Title: Cardholder conversion rate
Description: Calculated conversion rate from local currency into cardholder currency.
Type: number
Example:
5.3456
settlement_conversion_rate
Title: Settlement conversion rate
Description: Calculated conversion rate from local currency into settlement currency.
Type: number
Example:
5.3456
conversion_rate
Title: Conversion rate
Description: Calculated conversion rate from settlement currency into cardholder currency.
Type: number
Example:
5.3456
daily_iof_rate
Title: Daily IOF rate
Description: Rate of the daily IOF (Brazilian tax) used to calculate this authorization.
Type: number
Example:
0.0082
fixed_iof_rate
Title: Fixed IOF rate
Description: Rate of the fixed IOF (Brazilian tax) used to calculate this authorization.
Type: number
Example:
0.38
interest_rate
Title: Interest rate
Description: Interest rate used to calculate this authorization.
Type: number
Example:
9.9
international_iof_rate
Title: International IOF rate
Description: Rate of the international IOF (Brazilian tax) used to calculate this authorization.
Type: number
Example:
6.38
retrieval_reference_number
Title: Retrieval reference number
Description: The value received in the authorization message in field 37 of the Card Network Specification.
Type: string or null
Example:
000001119999
settlement_amount
Title: Settlement amount
Description: Amount of funds to be transferred between the acquirer and the issuer equal to the transaction amount in the settlement currency. This field represents the amount received in field 5 of the Card Network Specification.
Type: number or null
Example:
100.0
settlement_currency_code
Title: Settlement amount currency code
Description: Currency code of the settlement amount received in the authorization message - the value received in field 50 of the Card Network Specification.
Type: string or null
Example:
986
840
settlement_currency_code_literal
Title: Settlement amount currency code as literal
Description: Currency code of the settlement amount received in the authorization message as literal.
Type: string or null
Example:
BRL
EUR
soft_descriptor
Title: Merchant descriptor
Description: The merchant's name, city, and country concatenated.
Type: string or null
Example:
MERCHANT NAME SAO PAULO BRA
tid
Title: Transaction ID
Description: Transaction ID. Card network generated ID. It will be null in cases where the card network doesn't send this value. This field represents the value received in Field 62 subfield 2 for Visa requests and the DE63, subfield 2 for Mastercard requests.
Type: string or null
Example:
10119031908214800419
ABC123
token_information
Title: Token information
Description: Information about token used to authenticate authorization.
Type: object or nullid
Title: Token ID
Description: Automatically generated sequential internal identifier.
Type: null or integer
Example:
17084
17085
network_token
Title: Network Token
Description: Token identifier 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
17085
network_requestor_id
Title: Network requestor ID
Description: Wallet which requested 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
requestor_id
Title: Requestor ID
Description: Wallet which requested the token provisioning.
Type: null or string
Example:
APPLE_PAY
GOOGLE_PAY
type
Title: Token type
Description: Token type
Type: null or string
Example:
CARD_ON_FILE
EMBEDDED_SECURE_ELEMENT
track1_present
Title: Track1 present flag
Description: Indicates whether the authorization request was performed and the track1 (field 45 of the Card Network specification) was present in the message.
Type: boolean or null
Example:
true
false
track2_present
Title: Track2 present flag
Description: Indicates whether the authorization request was performed and the track2 (field 35 of the Card Network specification) was present in the message.
Type: boolean or null
Example:
true
false
transaction_status
Title: Authorization purpose Identifier
Description: The authorization request's purpose or status. For Visa request, it indicates if the authorization is a Normal Request or a Pre Authorized Request. For Mastercard requests, it represents the value of the DE61, subfield 7 that contains the same information as the Visa but can have some other purpose identifiers.
Type: string or null
Must be one of the following:
NORMAL_REQUEST
PRE_AUTHORIZED_REQUEST
SECURE_CODE_PHONE_ORDER
ATM_INSTALLMENT_INQUIRY
ATC_UPDATE
ACCOUNT_STATUS_INQUIRY_SERVICE
TOKENIZATION_REQUEST_OR_NOTIFICATION
type
Title: Event type
Description: Type of event. Currently, this event is only issued for authorizations so the value is a constant.
Constant:AUTH_EVENT
unique_cid required
Title: Unique correlation ID
Description: Unique correlation ID generated for each authorization action. In cancellation or confirmation, this CID is unique.
Type: string
Example:
dc123453-4444-1111-9999-53699d123456
validation_results
Type: array or null
Additional properties: falseadditional_data
Title: Additional data
Description: Additional information relevant to identify how the validation was performed. Every validation will have its own additional data, so please refer to the Pismo Developers Guide to identify every possibility.
Type: object or nulldescription required
Title: Description
Description: Detailed information about the validation result.
Type: string
Example:
TERMINAL_CAPABILITY_VALID
PIN_AND_CVV_VALID
name required
Title: Validation name
Description: Validation name.
Type: string
Example:
CVV2_INVALID
EXPIRATION_DATE_INVALID
ARQC_SIGNATURE_VALID
reason required
Title: Validation reason
Description: Validation result reason.
Type: null or string
Example:
TERMINAL_CAPABILITY_VALID
PIN_AND_CVV_VALID
status required
Title: Validation status
Description: Validation result status.
Type: string
Must be one of the following:
SKIPPED
APPROVED
REJECTED
three_domain_security
Title: Three Domain Security
Description: Information regarding the 3D Secure
Type: object or nullservice_indicator
Title: Service indicator
Description: Service indicator ID, corresponding to DE48 SE71 on Mastercard or F126 S20 on Visa.
Type: string or nullelectronic_commerce_indicator
Title: Electronic commerce indicator
Description: Electronic commerce indicator ID, corresponding to DE48 SE42 on Mastercard or F60 S08 on Visa.
Type: string or nullcardholder_authentication
Title: Cardholder authentication
Description: Cardholder authentication method, corresponding to DE48 SE43 on Mastercard or F44 S13 on Visa.
Type: string or nullauthentication_data
Title: Authetication data
Description: Cardholder authentication method, corresponding to DE48 SE66 on Mastercard or F126 S09 on Visa.
Type: string or null
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Network authorization received",
"description": "This event represents an authorization action. All actions (authorization, decline, confirmation, cancellation, partial cancellation. and so on) generate this event. Pismo issues this event after the message from the network is processed and a decision is made about the action to take. For more information, see the <a href='https://developers.pismo.io/pismo-docs/docs/authorization-events'>Authorization events</a> guide. Also see <a href='https://developers.pismo.io/pismo-docs/docs/linking-events-in-an-authorization-workflow' target='_blank'>Linking events in an authorization</a>.",
"required": [
"authorization_category",
"authorization_type",
"org_id",
"unique_cid",
"cid"
],
"properties": {
"authorization_category": {
"title": "Event category",
"description": "Category of authorization generating this event",
"type": "string",
"enum": [
"AUTHORIZATION",
"CONFIRMATION",
"DECLINED",
"CANCELLATION",
"PARTIAL_CANCELLATION",
"INSTALLMENT",
"AIRPORT_TAX",
"REPLACEMENT",
"INCREMENTAL",
"CANCELLATION_REVERSAL",
"REVERSAL_PARTIAL_CANCELLATION"
]
},
"authorization_type": {
"title": "Authorization type",
"description": "Type of authorization. Currently, this event is only issued for authorizations coming from the Card Network, so this field is a constant value.",
"const": "NETWORK"
},
"org_id": {
"title": "Org/tenant ID",
"description": "Pismo organization/tenant ID",
"type": "string",
"examples": [
"TN-99999999-1234-4321-5678-123456789012"
]
},
"account_id": {
"title": "Account ID",
"description": "Pismo account ID. This information is fetched using the Card used in the authorization. If no card is found, this information will not be present in the DECLINED event.",
"type": [
"integer",
"null"
],
"examples": [
15500,
1000
]
},
"acquirer_bin": {
"title": "Acquirer Identifier",
"description": "Identifies the acquiring institution (for example, merchant bank) or its agent. This field represents the value received in field 32 of the Card Network Specification.",
"type": [
"string",
"null"
],
"examples": [
"12345"
]
},
"advice_detail_code": {
"title": "Advice detail code",
"description": "Identifies the detail why the card network issued this advice. This field is only used for Mastercard requests and it represents the value received in the DE60 subfield 2 of the specification, if it is present in the card network message.",
"type": [
"string",
"null"
],
"examples": [
"0043",
"0045"
]
},
"advice_reason_code": {
"title": "Advice reason code",
"description": "Why the card network issued this advice. For messages other than advices, this field is null. In Mastercard requests this field represents the value received in the DE60 subfield 1 of the specification. For Visa requests, this field represents the value received in the F63.4 of the specification.",
"type": [
"string",
"null"
],
"examples": [
"120",
"9020"
]
},
"airport_tax": {
"title": "Airport tax amount",
"description": "Calculated airport tax amount in the cardholder's currency, received in confirmation messages for transactions of this type. The value will be null for confirmations that do not have airport tax included.",
"type": [
"number",
"null"
],
"examples": [
100.0
]
},
"anti_fraud_execution_time": {
"title": "Anti-fraud API response time",
"description": "Time in milliseconds between the anti-fraud API call and its response",
"type": [
"integer",
"null"
],
"examples": [
2000,
156
]
},
"anti_fraud_url": {
"type": [
"string",
"null"
],
"title": "",
"description": "Anti-Fraud API URL configured per Interbank Card Association (ICA) member.",
"examples": [
"our.antifraud.customer/my/path"
]
},
"arqc_present": {
"title": "ARQC present flag",
"description": "Authorization Request Cryptogram. Indicates whether the authorization request was performed and the cryptogram information (field 55 of the Card Network specification) was present in the message.",
"type": [
"boolean",
"null"
],
"examples": [
true
]
},
"atc": {
"title": "Application transaction counter",
"description": "The ATC (application transaction counter) is a counter, maintained by the chip card application (incremented by the chip), that provides a sequential reference to each transaction. This field is the ATC value for this card on this authorization. Only authorization requests with cryptogram information contain this counter.",
"type": [
"integer",
"null"
],
"examples": [
100,
null
]
},
"authorization_code": {
"title": "Authorization request authorization code",
"description": "An alphanumeric 6-digit code generated for an authorization request that can be used to relate this event to other events associated with the same authorization. For more information, see the <a href='https://developers.pismo.io/pismo-docs/docs/linking-events-in-an-authorization-workflow' target='_blank'>Linking authorization events</a> guide.",
"type": [
"string",
"null"
],
"examples": [
"ABC123"
]
},
"authorization_date_hour": {
"title": "Authorization UTC-3 date/time",
"description": "Request UTC-3 date and time - when the platform received the request from the network. No field in the Card Network message is considered.",
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2020-01-01T10:10:00"
]
},
"authorization_id": {
"title": "Authorization unique ID",
"description": "Authorization internal ID. This ID is unique and must be the same in all events related to the same authorization. It can be used to relate the current event with other events of the same authorization. For more information, see the <a href='https://developers.pismo.io/pismo-docs/docs/linking-events-in-an-authorization-workflow' target='_blank'>Linking authorization events</a> guide.",
"type": [
"integer",
"null"
],
"examples": [
100000,
125677
]
},
"authorization_response_code": {
"title": "Authorization response code ",
"description": "Response code the authorization platform assigns to the authorization request. Indicates whether it was declined or not.",
"type": "string",
"examples": [
"00",
"14"
]
},
"authorization_status": {
"title": "Authorization status",
"description": "Authorization internal status code. Current authorization status for the action which issued this event. (1- Pending, 2- Confirmed, 3- Declined, 4- Cancelled, 5- Dropped).",
"type": "integer",
"enum": [
1,
2,
3,
4,
5
]
},
"authorization_url": {
"type": [
"string",
"null"
],
"title": "Authorization URL",
"description": "Authorization API URL configured per program. Present when core-banking operations are made in our client's side.",
"examples": [
"our.authorization.customer/my/path"
]
},
"caller": {
"title": "Card network",
"description": "Card network generating the authorization request.",
"type": "string",
"examples": [
"Mastercard",
"Visa",
"tecban"
]
},
"cancelled_by_elapsed_time": {
"type": [
"boolean"
],
"title": "Cancelled by elapsed time flag",
"description": "Was an authorization cancelled due to elapsed time without a confirmation message flag. ",
"examples": [
true,
false
]
},
"card_acceptor_id": {
"title": "Card acceptor ID",
"description": "Identifies the card acceptor defining the transaction point in both local and interchange environments. This field represents the value received in field 42 of the Card Network Specification.",
"type": [
"string",
"null"
],
"examples": [
"000055551111009"
]
},
"card_id": {
"title": "Card ID",
"description": "Pismo card ID. If no card is found, based on the PAN received, this information will not be present in the DECLINED event.",
"type": [
"integer",
"null"
],
"examples": [
10222,
8899
]
},
"cardholder_currency_code": {
"title": "Currency Code of the Cardholder",
"description": "Cardholder ISO4217 currency code for currency used to bill the account. The final authorization amount is calculated in this currency.",
"type": [
"string",
"null"
],
"examples": [
"986"
]
},
"cardholder_currency_code_literal": {
"title": "Currency Code of the Cardholder as Literal",
"description": "Field represent Cardholder ISO4217 currency code for currency used to bill the account as literal.",
"type": [
"string",
"null"
],
"examples": [
"BRL"
]
},
"cid": {
"title": "Authorizaton correlation ID",
"description": "Authorization correlation ID . Along with the `authorization_id`, you can use this field to relate it to other events associated with this authorization. For more information, see the <a href='https://developers.pismo.io/pismo-docs/docs/linking-events-in-an-authorization-workflow' target='_blank'>Linking authorization events</a> guide.",
"type": "string",
"examples": [
"dc123453-4444-1111-9999-53699d123456"
]
},
"conciliation_information": {
"title": "Conciliation information",
"description": "Information regarding the conciliation message being processed for this authorization.",
"type": [
"object",
"null"
],
"properties": {
"acquirer_reference_number": {
"title": "Acquirer reference number",
"description": "Acquirer-supplied data in an acquirer-originated message. An issuer may be required to return this data in a subsequent message to the acquirer.",
"type": [
"string",
"null"
],
"examples": [
"22223021032000000000680"
]
},
"installment_number": {
"title": "Installment current number",
"description": "Indicates the installment number in the concilation message being processed.",
"type": [
"number",
"null"
],
"examples": [
2,
10
]
},
"interchange_fee_amount": {
"title": "Interchange fee amount",
"description": "Interchange fee amount received in the conciliation message. Every time a retailer processes a credit card or debit card payment, the merchant pays an interchange fee. This fee, often called a 'swipe fee,' is designed to cover the costs associated with accepting, processing and authorizing card transactions.",
"type": [
"number",
"null"
],
"examples": [
0.0082,
1.1657
]
},
"interchange_fee_indicator": {
"title": "Credit or debit fee indicator",
"description": "Indicates if the interchange fee amount is a debit or a credit.",
"type": [
"string",
"null"
],
"enum": [
"CREDIT",
"DEBIT",
"NOT_APPLICABLE"
]
},
"message_number": {
"title": "Conciliation message number",
"description": "Card network assigned number in the conciliation file for this conciliation message.",
"type": [
"string",
"null"
],
"examples": [
"9920",
"0001"
]
},
"processing_julian_date": {
"title": "Assigned Julian date",
"description": "Julian processing date the acquirer assigns to the First Presentment/1240 in the format YDDD.",
"type": [
"string",
"null"
],
"examples": [
"0350",
"1220"
]
}
}
},
"conciliation_type": {
"title": "Program conciliation type",
"description": "Type of conciliation used for this authorization. Single message for authorizations which create transactions from Base I messages, Dual message for authorizations which create transactions from Base II messages.",
"type": "string",
"enum": [
"SINGLE_MESSAGE",
"DUAL_MESSAGE",
"UNDEFINED"
]
},
"contract_amount": {
"title": "Authorization contract amount",
"description": "Calculated authorization amount, including taxes or fees, in the cardholder's currency. For Declined transactions this field may be null, since no calculation was performed.",
"type": [
"number",
"null"
],
"examples": [
110.0
]
},
"created_from_authorization_not_found": {
"type": [
"boolean"
],
"title": "Created from authorization not found flag",
"description": "Indicates whether an authorization was created in the clearing flow for scenarios where we didn't find a corresponding Base1 Authorization.",
"examples": [
true,
false
]
},
"custom_response_code": {
"title": "Internal denial Code",
"description": "Internal custom code generated in authorization flow for declined requests. Indicates the reason the request was declined. For more information, see the <a href='https://developers.pismo.io/pismo-docs/docs/validation-codes-for-authorization-events' target='_blank'>Validation codes for authorization events</a> guide",
"type": [
"string",
"null"
],
"examples": [
"BND",
"810",
"FR2"
]
},
"merchant_denial_code": {
"title": "Merchant denial code",
"description": "This code communicates the reason for declining the authorization and the course of action that merchants can take. The code depends on the card network. For example, Mastercard uses Merchant Advice Code (MAC) and Visa uses Recurring Payment Cancellation (RPC).",
"type": [
"string",
"null"
],
"examples": [
"02",
"03"
]
},
"customer_id": {
"title": "Customer ID",
"description": "ID of customer holding card used in this authorization. If no card is found, this information will be null in the DECLINED event.",
"type": [
"integer",
"null"
],
"examples": [
10222,
8899
]
},
"cvv_present": {
"title": "CVV present flag",
"description": "Indicates whether the authorization request was performed and the card's CVV (card verification value) was present.",
"type": [
"boolean",
"null"
],
"examples": [
true,
false
]
},
"event_date_hour": {
"title": "Received message date/time",
"description": "Date and time Network/Acquirer message received. This field represents the value contained in fields 12 (Time) and 13 (Date) of the Card Network Specification. If these values are present, they are used without validations and since the network only sends the day and month, the current year is assumed. If they are not present, the current time of the authorization is used (UTC-3).",
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2020-01-01T10:10:00"
]
},
"event_date_hour_utc": {
"title": "DateTime in UTC",
"description": "Authorization UTC date and time. This field considers the time when the platform received the request from the Network to define its value. No field in the Card Network message is considered.",
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2020-01-01T10:10:00Z"
]
},
"file_date": {
"title": "File processing date",
"description": "Date when issuer processed the Base II file.",
"type": [
"string",
"null"
],
"examples": [
"2020-01-01"
]
},
"incoming_authorization_code": {
"title": "Authorization code ",
"description": "Authorization code from the card network in field 38 of the message request. If the request was approved in the Stand-In flow, this field indicates the authorization code assigned to this message.",
"type": [
"string",
"null"
],
"examples": [
"ABC123",
"123456"
]
},
"incoming_response_code": {
"title": "Network response code",
"description": "Any response code from the Card Network in field 39 of the message request. It indicates whether the request was approved in the Stand-In flow.",
"type": [
"string",
"null"
],
"examples": [
"0043",
"0045"
]
},
"installment_amount": {
"title": "Calculated authorization installment amount",
"description": "Calculated amount of each installment in the authorization in the cardholder's currency. For authorizations without installments, this field will be the same as the total authorization amount. For Declined transactions this field may be null, since no calculation was performed.",
"type": [
"number",
"null"
],
"examples": [
55.0
]
},
"installments_information": {
"title": "Installment information",
"description": "Details about all installments and their amounts.",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"installment_amount": {
"title": "Total installment amount",
"description": "Calculated total amount for all installments.",
"type": [
"number"
],
"examples": [
100.0
]
},
"number": {
"title": "Installment number",
"description": "Identifies which installment this object is about.",
"type": [
"number"
],
"examples": [
1,
2,
3
]
},
"postings": {
"title": "Installment fees and taxes.",
"description": "Taxes and fees calculated for this installment.",
"type": [
"object",
"null"
],
"properties": {
"amortization": {
"title": "Installment amortization amount",
"description": "Calculated amortization amount for this installment when calculating a purchase with installments and interest.",
"type": "number",
"examples": [
10.0
]
},
"daily_iof_amount": {
"title": "Daily IOF (Brazilian tax) amount",
"description": "Calculated installment's daily IOF (Brazilian tax) amount in the cardholder's currency.",
"type": "number",
"examples": [
0.45
]
},
"fixed_iof_amount": {
"title": "Fixed IOF (Brazilian tax) amount",
"description": "Calculated installment's daily fixed IOF (Brazilian tax) in the cardholder's currency. The calculated fixed amount is always set to the first installment.",
"type": "number",
"examples": [
0.78
]
},
"interest_amount": {
"title": "Interest amount",
"description": "Calculated installment interest in the cardholder's currency.",
"type": "number",
"examples": [
1.37
]
},
"iof_amount": {
"title": "IOF (Brazilian tax) amount",
"description": "Calculated installment IOF (Brazilian tax) in the cardholder's currency. This field sums the installment's daily and fixed IOF amount",
"type": "number",
"examples": [
0.45
]
}
}
}
}
}
},
"labels": {
"title": "Authorization Labels",
"description": "List with all labels related to this authorization. Each label identifies an authorization characteristic. DCC = Dynamic currency conversion, ATC = Application transaction counter",
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"DCC",
"INCREMENT_ATC",
"INCREMENT_PASSWORD_TRIES",
"INCREMENT_NUMBER_OF_TRANSACTIONS",
"BLOCK_CARD",
"CLEAR_PASSWORD_TRIES"
]
}
},
"ledger_update_id": {
"title": "Ledger update ID",
"description": "ID from Ledger API indicating the account limit impact. This field may be null since some authorizations don't have any financial impact.",
"type": [
"string",
"null"
],
"examples": [
"dc123453-4444-1111-9999-53699d123456"
]
},
"local_amount": {
"title": "Authorization local amount",
"description": "Amount in local currency where the authorization was requested. The value received in field 4 of the Card Network Specification.",
"type": [
"number",
"null"
],
"examples": [
100.0
]
},
"local_currency_code": {
"title": "Local amount currency code",
"description": "Currency code of the place where the authorization was requested. The value received in field 49 of the Card Network Specification.",
"type": [
"string",
"null"
],
"examples": [
"986",
"840"
]
},
"local_currency_code_literal": {
"title": "Local amount currency code as literal",
"description": "Currency code of the place where the authorization was requested as literal.",
"type": [
"string",
"null"
],
"examples": [
"BRL",
"USD"
]
},
"merchant_category_id": {
"title": "Merchant category code",
"description": "Merchant category code based on the merchant's type of business or service. This field represents the value received in field 18 of the Card Network Specification.",
"type": [
"string",
"null"
],
"examples": [
"5199",
"3040"
]
},
"merchant_city": {
"title": "Card acceptor (merchant) city",
"description": "Merchant's city. This field represents the value received in field 43, subfield 2, of the Card Network Specification.",
"type": [
"string",
"null"
],
"examples": [
"Sao Paulo"
]
},
"merchant_name": {
"title": "Card acceptor (merchant) name",
"description": "Merchant's 'doing business as' name. This field represents the value received in field 43, subfield 1, of the Card Network Specification.",
"type": [
"string",
"null"
],
"examples": [
"Acme Dry Goods"
]
},
"merchant_state_or_country": {
"title": "Card acceptor (merchant) country/state",
"description": "Merchant's country/state. This field represents the value received in field 43, subfield 3, of the Card Network Specification.",
"type": [
"string",
"null"
],
"examples": [
"BRA"
]
},
"merchant_zip_code": {
"title": "Card acceptor (merchant) postal code",
"description": "Postal code of merchant where the transaction took place.",
"type": [
"string",
"null"
],
"examples": [
"12345999"
]
},
"metadata": {
"title": "Anti-fraud metadata",
"description": "Any valid JSON sent in the response from the anti-fraud request. This information is saved and sent in this event as it was received by the platform, without any further processing.",
"type": [
"object",
"null"
]
},
"mti": {
"title": "Message type indicator",
"description": "Message type indicator - Card Network request type. Can be used to identify whether the request is an Advice (Standin flow) or not. For more information, see <a href='https://en.wikipedia.org/wiki/ISO_8583#Message_type_indicator_(MTI)' target='_blank'>MTI</a>",
"type": "string",
"examples": [
"0100",
"0120"
]
},
"nsu": {
"title": "Message initiator ID",
"description": "Message initiator assigned ID that uniquely identifies a transaction. This field contains the value received in the authorization message in field 11 of the Card Network Specification.",
"type": [
"string",
"null"
],
"examples": [
"999000"
]
},
"number_of_installments": {
"title": "Authorization number of installments",
"description": "In purchases with installments, this field represents the number of installments for which the authorization was requested. For any operation other than purchase with installments, this value should be 1.",
"type": [
"integer",
"null"
],
"examples": [
3
]
},
"org_operation_id": {
"title": "Operation unique ID",
"description": "Internal identifier of the operation performed on this authorization. This information is related to the Processing Code (field 3 in the Card Network Specification) of the authorization. If the Operation is not allowed for that program or the Processing Code is not mapped, this field will not be present in the DECLINED event.",
"type": [
"integer",
"null"
],
"examples": [
10,
145
]
},
"origin": {
"title": "Transaction origin",
"description": "Identifies where one transaction was issued, if it is from STRIKER('Rebatedor') or migrated from historical data",
"type": [
"string",
"null"
],
"enum": [
"STRIKER",
"MIGRATION"
]
},
"original_authorization_date_hour": {
"title": "Original authorization UTC-3 date/time",
"description": "UTC-3 sate and time of the original authorization. Indicates the time when the platform received the request that creates the authorization from the Network. No field in the Card Network message is considered. If this is the authorization request, the value of this field will be the same as the `authorization_date_hour`. For other requests such as cancellation and confirmation, this field's value will be the date when the authorization was first requested.",
"type": "string",
"format": "date-time",
"examples": [
"2020-01-01T10:10:00"
]
},
"original_event_date_hour_utc": {
"title": "Original authorization UTC-0 date/timeDate",
"description": "UTC-0 date and time of the original authorization. Indicates when the platform received the request that creates the authorization from the network. No field in the Card Network message is considered. If this is the authorization request, the value of this field will be the same as the `event_date_hour_utc`. For other requests such as cancellation and confirmation, the value of this field will be the date when the authorization was first requested.",
"type": "string",
"format": "date-time",
"examples": [
"2020-01-01T10:10:00Z"
]
},
"pan": {
"title": "Primary account number hash",
"description": "Hashed PAN (Primary Account Number). This hash is generated from the PAN and is unique inside the platform. You can use it to identify a card together with the `card_id` field.",
"type": [
"string",
"null"
],
"examples": [
"nabcdef5432111abcde6543217abcdefGHHHZZZZfGZ119292999g=="
]
},
"password_present": {
"title": "Password present flag",
"description": "Indicates whether the authorization request was performed and the card's password is present.",
"type": [
"boolean",
"null"
],
"examples": [
true,
false
]
},
"point_of_sale": {
"title": "Point of sale (POS) information",
"description": "Information regarding the POS.",
"type": [
"object",
"null"
],
"properties": {
"entry_mode": {
"type": "string",
"title": "Authorization entry mode",
"description": "The method used for PAN entry to initiate a transaction and the PIN entry capabilities. This field represents the value received in field 22 of the Card Network Specification.",
"examples": [
"010",
"051"
]
}
}
},
"postings": {
"description": "Authorization taxes and fees.",
"type": [
"object",
"null"
],
"properties": {
"cash_back_amount": {
"title": "Cash back amount",
"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",
"examples": [
200.0
]
},
"fee_amount": {
"title": "Fee amount",
"description": "Calculated fee for this authorization in the cardholder's currency.",
"type": "number",
"examples": [
15.0
]
},
"interest_amount": {
"title": "Interest rate",
"description": "Calculated amount of interest rate for this authorization in the cardholder's currency.",
"type": "number",
"examples": [
10.0
]
},
"iof_amount": {
"title": "IOF amount",
"description": "Calculated amount of IOF (Brazilian tax) for this authorization in the cardholder's currency.",
"type": "number",
"examples": [
6.38
]
},
"purchase_amount": {
"title": "Purchase amount",
"description": "In a purchase with cash back or POS withdrawal, this is the amount related to the purchase itself. The principal amount is the sum of this amount with the cash back amount.",
"type": "number",
"examples": [
200.0
]
}
}
},
"principal_amount": {
"title": "Principal authorization amount",
"description": "Calculated amount of the authorization without taxes or fees in the cardholder's currency. For Declined transactions this field may be null, since no calculation was performed.",
"type": [
"number",
"null"
],
"examples": [
100.0
]
},
"processing_code": {
"title": "Processing code",
"description": "Type of request being processed, like purchase, withdrawal, purchase with installments, credit return and so on. See <a href='https://developers.pismo.io/pismo-docs/docs/processing-codes-and-transaction-types' target='_blank'>Processing codes and transaction types</a> for more information",
"type": "string",
"examples": [
"00",
"01"
]
},
"program_id": {
"title": "Program ID",
"description": "Internal identifier of the card's program used for this authorization. If no card is found, this information will not be present in the DECLINED event.",
"type": [
"integer",
"null"
],
"examples": [
100,
500
]
},
"rates": {
"description": "Contains the rates used to calculate the amounts of this authorization.",
"type": [
"object",
"null"
],
"properties": {
"cardholder_conversion_rate": {
"title": "Cardholder conversion rate",
"description": "Calculated conversion rate from local currency into cardholder currency.",
"type": "number",
"examples": [
5.3456
]
},
"settlement_conversion_rate": {
"title": "Settlement conversion rate",
"description": "Calculated conversion rate from local currency into settlement currency.",
"type": "number",
"examples": [
5.3456
]
},
"conversion_rate": {
"title": "Conversion rate",
"description": "Calculated conversion rate from settlement currency into cardholder currency.",
"type": "number",
"examples": [
5.3456
]
},
"daily_iof_rate": {
"title": "Daily IOF rate",
"description": "Rate of the daily IOF (Brazilian tax) used to calculate this authorization.",
"type": "number",
"examples": [
0.0082
]
},
"fixed_iof_rate": {
"title": "Fixed IOF rate",
"description": "Rate of the fixed IOF (Brazilian tax) used to calculate this authorization.",
"type": "number",
"examples": [
0.38
]
},
"interest_rate": {
"title": "Interest rate",
"description": "Interest rate used to calculate this authorization.",
"type": "number",
"examples": [
9.9
]
},
"international_iof_rate": {
"title": "International IOF rate",
"description": "Rate of the international IOF (Brazilian tax) used to calculate this authorization.",
"type": "number",
"examples": [
6.38
]
}
}
},
"retrieval_reference_number": {
"title": "Retrieval reference number",
"description": "The value received in the authorization message in field 37 of the Card Network Specification.",
"type": [
"string",
"null"
],
"examples": [
"000001119999"
]
},
"settlement_amount": {
"title": "Settlement amount",
"description": "Amount of funds to be transferred between the acquirer and the issuer equal to the transaction amount in the settlement currency. This field represents the amount received in field 5 of the Card Network Specification.",
"type": [
"number",
"null"
],
"examples": [
100.0
]
},
"settlement_currency_code": {
"title": "Settlement amount currency code",
"description": "Currency code of the settlement amount received in the authorization message - the value received in field 50 of the Card Network Specification.",
"type": [
"string",
"null"
],
"examples": [
"986",
"840"
]
},
"settlement_currency_code_literal": {
"title": "Settlement amount currency code as literal",
"description": "Currency code of the settlement amount received in the authorization message as literal.",
"type": [
"string",
"null"
],
"examples": [
"BRL",
"EUR"
]
},
"soft_descriptor": {
"title": "Merchant descriptor",
"description": "The merchant's name, city, and country concatenated.",
"type": [
"string",
"null"
],
"examples": [
"MERCHANT NAME SAO PAULO BRA"
]
},
"tid": {
"title": "Transaction ID",
"description": "Transaction ID. Card network generated ID. It will be null in cases where the card network doesn't send this value. This field represents the value received in Field 62 subfield 2 for Visa requests and the DE63, subfield 2 for Mastercard requests.",
"type": [
"string",
"null"
],
"examples": [
"10119031908214800419",
"ABC123"
]
},
"token_information": {
"title": "Token information",
"description": "Information about token used to authenticate authorization.",
"type": [
"object",
"null"
],
"properties": {
"id": {
"title": "Token ID",
"description": "Automatically generated sequential internal identifier.",
"type": [
"null",
"integer"
],
"examples": [
17084,
17085
]
},
"network_token": {
"type": [
"null",
"string"
],
"title": "Network Token",
"description": "Token identifier 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": "Wallet which requested 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"
]
},
"requestor_id": {
"title": "Requestor ID",
"description": "Wallet which requested the token provisioning.",
"type": [
"null",
"string"
],
"examples": [
"APPLE_PAY",
"GOOGLE_PAY"
]
},
"type": {
"title": "Token type",
"description": "Token type",
"type": [
"null",
"string"
],
"examples": [
"CARD_ON_FILE",
"EMBEDDED_SECURE_ELEMENT"
]
}
}
},
"track1_present": {
"title": "Track1 present flag",
"description": "Indicates whether the authorization request was performed and the track1 (field 45 of the Card Network specification) was present in the message.",
"type": [
"boolean",
"null"
],
"examples": [
true,
false
]
},
"track2_present": {
"title": "Track2 present flag",
"description": "Indicates whether the authorization request was performed and the track2 (field 35 of the Card Network specification) was present in the message.",
"type": [
"boolean",
"null"
],
"examples": [
true,
false
]
},
"transaction_status": {
"title": "Authorization purpose Identifier",
"description": "The authorization request's purpose or status. For Visa request, it indicates if the authorization is a Normal Request or a Pre Authorized Request. For Mastercard requests, it represents the value of the DE61, subfield 7 that contains the same information as the Visa but can have some other purpose identifiers.",
"type": [
"string",
"null"
],
"enum": [
"NORMAL_REQUEST",
"PRE_AUTHORIZED_REQUEST",
"SECURE_CODE_PHONE_ORDER",
"ATM_INSTALLMENT_INQUIRY",
"ATC_UPDATE",
"ACCOUNT_STATUS_INQUIRY_SERVICE",
"TOKENIZATION_REQUEST_OR_NOTIFICATION"
]
},
"type": {
"title": "Event type",
"description": "Type of event. Currently, this event is only issued for authorizations so the value is a constant.",
"const": "AUTH_EVENT"
},
"unique_cid": {
"title": "Unique correlation ID",
"description": "Unique correlation ID generated for each authorization action. In cancellation or confirmation, this CID is unique.",
"type": "string",
"examples": [
"dc123453-4444-1111-9999-53699d123456"
]
},
"validation_results": {
"title": "Validation results",
"description": "All executed validations with details for each result.",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"additional_data": {
"title": "Additional data",
"description": "Additional information relevant to identify how the validation was performed. Every validation will have its own additional data, so please refer to the Pismo Developers Guide to identify every possibility.",
"type": [
"object",
"null"
]
},
"description": {
"title": "Description",
"description": "Detailed information about the validation result.",
"type": [
"string"
],
"examples": [
"TERMINAL_CAPABILITY_VALID",
"PIN_AND_CVV_VALID"
]
},
"name": {
"title": "Validation name",
"description": "Validation name.",
"type": [
"string"
],
"examples": [
"CVV2_INVALID",
"EXPIRATION_DATE_INVALID",
"ARQC_SIGNATURE_VALID"
]
},
"reason": {
"title": "Validation reason",
"description": "Validation result reason.",
"type": [
"null",
"string"
],
"examples": [
"TERMINAL_CAPABILITY_VALID",
"PIN_AND_CVV_VALID"
]
},
"status": {
"title": "Validation status",
"description": "Validation result status.",
"type": [
"string"
],
"enum": [
"SKIPPED",
"APPROVED",
"REJECTED"
]
}
},
"required": [
"name",
"status",
"reason",
"description"
]
}
},
"three_domain_security": {
"title": "Three Domain Security",
"description": "Information regarding the 3D Secure",
"type": [
"object",
"null"
],
"properties": {
"service_indicator": {
"title": "Service indicator",
"description": "Service indicator ID, corresponding to DE48 SE71 on Mastercard or F126 S20 on Visa.",
"type": [
"string",
"null"
]
},
"electronic_commerce_indicator": {
"title": "Electronic commerce indicator",
"description": "Electronic commerce indicator ID, corresponding to DE48 SE42 on Mastercard or F60 S08 on Visa.",
"type": [
"string",
"null"
]
},
"cardholder_authentication": {
"title": "Cardholder authentication",
"description": "Cardholder authentication method, corresponding to DE48 SE43 on Mastercard or F44 S13 on Visa.",
"type": [
"string",
"null"
]
},
"authentication_data": {
"title": "Authetication data",
"description": "Cardholder authentication method, corresponding to DE48 SE66 on Mastercard or F126 S09 on Visa.",
"type": [
"string",
"null"
]
}
}
}
}
}
Updated 3 days ago