| Field | Type | Description | Req |
|---|---|---|---|
| **`custom_codes`** | string array | Card status validation codes indicating Pismo's findings. Issuer can still approve. Note that custom codes are listed elsewhere, but not all apply to this webhook. Refer to Custom codes table below. | No |
| **`token_id`** | number | Pismo-issued token ID. You can use this to call the [Get token information](https://developers.pismo.io/pismo-docs/reference/gettokeninfo) endpoint. | Yes |
| **`network_brand`** | enum string | * `vts` - Visa * `mdes` - Mastercard | Yes |
| **`network_call_method`** | enum string | * `VTS_DEVICE_BINDING` * `TA` * `VTS_APPROVE_PROVSIONING` * `VTS_APPROVE_PROVISIONG_ISO` | Yes |
| **`card`** | object | ||
| `id` | number | Pismo-assigned card ID | Yes |
| `type` | enum string | Card type: * `PLASTIC` * `VIRTUAL` * `RECURRING` * `TEMPORARY` | Yes |
| `program_id` | number | Program ID | Yes |
| `bin` | string | Bank identification number | Yes |
| `status` | enum string | Card status: * `created` * `normal` * `damaged` * `warning` * `lost` * `unknown` | No |
| `stage` | enum string | Card lifecycle status * `unknown` * `blocked` * `unblocked` | No |
| **`combo_card`** | object | No | |
| `status` | enum string | Card status: * `created` * `normal` * `damaged` * `warning` * `lost` * `unknown` | |
| **`original_network_data`** | object | Refer to the [VISA Token Service (VTS)\ Issuer API Specifications (JSON) manual](https://developer.visa.com/capabilities/token-service-provisioning) or the [Mastercard Customer Interface Specification manual](https://techdocs.mastercard.com/bundle/m_CI) for more information on the contents of this field. (The Mastercard manual requires a Mastercard Connect ID log in for access). | No |
Custom codes
VTS = Visa, MDES = Mastercard.
| Custom code | Description | VTS action code | MDES action code | | :----------- | :---------------------------------------------------------------- | :--------------- | :--------------- | | `CCS` | Card status =`CANCELLED` | 46 | 05 | | `CED` | Invalid expiration date. Exp date entered does not match Pismo's. | 54 | 05 | | `CNN` | Card is not in`NORMAL` status | 05 | 05 | | `EXPCRD` | Expired card | 05 | 05 | | `FR2` | Entered CVV2 is invalid | N7 | 05 | | `FRB` | `CREATED` status not allowed | 05 | 05 | | `HSE` | HSM failed to validate CVV2. | 05 | 05 | | `NPL` | Card not plastic. Issuer can override for virtual card. | 05 | 05 | | `UBT` | Blocked card. Legacy | 05 | 05 | | `ELFR2` | CVV2 retry limit exceeded | 05 | 05 | | `MATPC` | Exceeded maximum active tokens per card | 05 | 05 | | `FRE` | Cryptogram data validation failed | 05 | 05 || Field | Type | Description | Required |
|---|---|---|---|
| **`approve`** | boolean | Card approved flag | Yes |
| **`action_code`** | string | Decision code: * `00` - Approved * `05` - Not approved * `14` - Invalid PAN * `46` - Closed account * `54` - Invalid expiration date * `57` - Not permitted * `58` - Not allowed on terminal * `85` - Needs challenge * `96` - Issuer internal system error * `N7` - Invalid CVV2 | Yes |
| **`step_up_methods`** | object array | Needs challenge methods. At least one is required if used. | Yes if `action_code` = `85`. |
| `method` | enum string | One-time passcode (OTP) challenge method: * `OTPSMS` - SMS * `OTPAPP` - App * `OTPCALL` - Call | |
| `value` | string | Additional information for challenge - phone number, app, and so on. | |
| `platform` | enum string | Only used for Visa and only when the method is `OPTAPP`: * `IOS` * `ANDROID` * `WINDOWS` * `WEB` | |
| `source` | string | Only used for Visa and under certain conditions. This is the **Source Address** field as discussed in the VISA VTS manual and you should read that document for more information. |
| Field | ;Type | Description | Req |
|---|---|---|---|
decision
|
string | Pismo decision Enum: [ " approve". "reject" ] |
Y |
id
|
string | Request ID | Y |
datetime
|
string | Call datetime in ISO 8601 format | Y |
account_id
|
string | Pismo account ID | Y |
currency_code
|
string | ISO 4217 currency code. For example: 986=Brazil, 840=US. | Y |
amount
|
number | Transaction amount | Y |
origin
|
string | Transaction origin:
Enum:[ " banking",
"instant-pay".
"onus"]
|
Y |
operation_type
|
string | Operation type:
Enum: [ " cashin",
"cashout" ]
|
Y |
processing_code
|
string | Processing code. For more information see Processing codes and transaction types | Y |
entities
|
object | Details of entities related to the transaction. | N |
account
|
object | Account information. | N |
name
|
string | Customer name | N |
document_number
|
string | Customer government document number. | N |
creation_date
|
string | Creation datetime in ISO 8601 format. | N |
limits
|
object | Limits | N |
total
|
number | Total | N |
address
|
object | Address information. | N |
zipcode
|
string | Postal code | N |
phone
|
object | Phone information. | N |
area
|
string | Area code. | N |
country
|
string | Country code. | N |
number
|
string | Phone number | N |
metadata
|
object | Any JSON name-value pairs | N |
raw
|
object | Platform additional information forwarded to the anti-fraud system, varies according to origin. Sent only in on-us transactions. | N |
| Field | Type | Description | Req |
|---|---|---|---|
decision
|
string | Client decision
Enum: [ " approve", "
reject"]
|
Y |
metadata
|
object | Any JSON name-value pairs | N |
| Field | Type | Description | Req |
|---|---|---|---|
x-tenant |
string | Organization/tenant ID | N |
x-cid |
string | Authorization correlation ID. The CID is used to link related API requests and events. For example, if a user makes an authorization request with 10 installments, this generates 1 authorization event and 10 transaction events all containing the same correlation ID. The x-cid can help the Pismo engineering team track everything related to a call. If one isn't passed, it is automatically generated. You can find it in a response header. | N |
Authorization |
string | Access token | N |
Content-type |
string | A specification for a structured, used application/json | N |
User-Agent |
string | The user agent responsible for making a given HTTP request. For example, pismo/http-client. | N |
| Field | Type | Description | Req |
|---|---|---|---|
id
|
string | Database transaction ID | Y |
entity
|
string | Entity type enum:
- transaction
|
Y |
fields
|
object | Fields submitted through zero balance anti-fraud ingress requests. Note that each entity type has some exclusive fields (Those fields have an additional note between []). | Y |
mti
|
string | Message type ID. For example:
0100 = auth. request
0110 = auth. response
0120 = auth. advice
For more information, refer to MTI. |
Y |
card_id
|
int | Transaction cardholder card ID | Y |
account_id
|
int | Transaction cardholder account ID | Y |
amount_transaction
|
number | Transaction amount in the cardholder's billing currency | Y |
amount_local
|
number | Transaction amount in the merchant's local currency | Y |
transaction_timestamp
|
string | Transaction date and hour (format:yyyy-MM-dd hh:mm:ss) | Y |
amount_settlement
|
number | Amount in settlement currency defined by the issuer | Y |
processing_code
|
string | Transaction's effect on the customer account and the type of accounts affected.
"00" for purchase
"01" for withdraw
"20" for refund
"28" for payment |
Y |
currency
|
string | Transaction country currency code - ISO 4217. For example,
840 (US)
986 (Brazil)
|
Y |
payment_card_brand
|
string | null | Transaction brand -
Visa or
Mastercard.
|
N |
merchant_id_code
|
string | Merchant code as registered at the payments network database (Visa/Mastercard) | N |
merchant_name
|
string | Merchant name as registered at the payments network database (Visa/Mastercard) | N |
merchant_city
|
string | Merchant city as registered at the payments network database (Visa/Mastercard) | N |
merchant_state_or_country_code
|
string | Merchant country code outside USA (OR) Merchant state code from the USA (OR) Canadian province code from Canada.
NOTE: Canadian merchants can either be represented through the province code or the canadian country code. |
N |
merchant_terminal_id
|
string | Terminal ID at acquirer database | N |
atc_chip
|
string | Application Transaction Counter acquired from ISO8583 formatted payments network message | N |
atc_database
|
string | null | Application Transaction Counter acquired from authorization platform database. Comma-separated array of numbers, for example "[1, 3, 6]". | N |
cvv_data
|
string | CVV data | N |
entry_mode
|
string | Method used for PAN entry to initiate a transaction and the PIN entry capabilities. This field is required and must have 3 or 4 digits.
For example, try 901 or
9010 for magnetic stripe transaction simulation.
|
N |
mcc
|
string | Merchant category codes payments network. | N |
card_type
|
string | Transaction cardholder card type enum:
PLASTIC
VIRTUAL
TEMPORARY
RECURRING
|
N |
country_code
|
string | Card issuer location's country code - ISO 3166-1 | N |
chip_validation
|
bool | Is chip valid flag | N |
postal_code
|
string | Card issuer location's postal code | N |
chip_cryptogram_information_data
|
string | null | Relevant information data from cardholder chip | N |
chip_transaction_date
|
string | null | Transaction date from cardholder chip. Format: yymmdd. |
N |
chip_transaction_type
|
string | Specific transaction type | N |
chip_amount_authorized
|
string | null | Amount authorized for cardholder. Format: 000000000010) | N |
chip_transaction_currency_code
|
string | null | Specific given currency code | N |
chip_application_interchange_profile
|
string | null | Application interchange profile information | N |
chip_terminal_country_code
|
string | null | Terminal country code from payment network. | N |
chip_cardholder_verification_method
|
string | null | Cardholder authorization verification method | N |
chip_terminal_capabilities
|
string | null | Capability code given by POS. Each code has the list of capabilities classified. | N |
chip_amount_other
|
string | niull | If there is no cash back amount, the value of 9F03 is zero. 9F03 may be absent, or present with a zero value.
If there is a cash back amount, presence is mandatory. |
N |
chip_application_transaction_counter
|
string | null | DE 120 (record data) contains Application Transaction Counter file data when DE 101 (file name) contains MCC109 | N |
cardholder_postal_code
|
string | null | Cardholder postal code | N |
transaction_type
|
string| null | Processing code that describes the transaction type being authorized | N |
nsu
|
string | Authorization Network Settlement Utility (NSU) number which tracks the flow of funds between parties involved in a payment card transaction, including the bank, the merchant, and the card network.
Different payment card networks may have their own NSU systems (e.g., Visa - VisaNet, Mastercard - BankNet) or they may use a third party. |
N |
retrieval_reference_number
|
string | Merchant POS system generated number | N |
authorization_code
|
string | Authorization code | Y 6-character alphanumeric code. When the network provides an authorization code in the advice (e.g., STIP), the network-provided code is used. Otherwise, a code is generated by the issuer processor. |
incoming_authorization_code
|
string | Authorization code from card network | C Original authorization code received from the network. Only present when the network provides one (e.g., STIP advice scenarios). Empty when the authorization originated from the issuer. |
response_code
|
string | Network two digit response code. For example:
00 = approve
51 = insufficient funds
57 = card not active
96 = system failure, etc.
For more information, refer to Validation codes for authorization events. If approve =
false, you can use this value to respond to the network.
|
Y |
terminal_capability
|
string | null | Point-of-sale (POS) entry mode code | N |
tvr
|
string | null | Terminal verification results: serves as notification of bit validation errors detected in the TVR within the issuer application data during M/Chip Cryptogram Validation processing. | N |
cvr
|
string | null | Card verification results: serves as notification of bit validation errors detected in the CVR within the issuer application data during M/Chip Cryptogram Validation processing. | N |
number_of_installments
|
int | Authorization's number of installments | N |
network_score
|
number | Payment network score: empty field when no information is present. | N |
pos_postal_code
|
string | Terminal machine authorizer postal code | N |
acquirer_code
|
string | Authorizer acquirer code | N |
denial_code
|
string | Code that identifies reason the transaction was denied | N |
financial_network_code
|
string | Financial code from card network | N |
banknet_reference_number
|
string | Authorization banknet reference number | N |
original_network_data
|
object | Raw ISO-8583 message without sensitive fields. | R |
cvv_presence
|
bool | Is CVV data present flag | N |
password_present
|
bool | Is password used flag | N |
account_type
|
string | Account type:
00 for non specified
10 for savings
20 for checking
30 for credit card
|
N |
validation_results
|
object array | Performed validations list | N |
name
|
string | Validation ID
See Authorization rule list for more information. |
N |
status
|
string | Execution status:
APPROVED
REJECTED
SKIPPED
|
N |
reason
|
string | Reason enum
For more information, refer to the authorization list of rules guide. |
N |
description
|
string | Human-readable result reason | N |
program_id
|
integer | Program ID | N |
token_id
|
integer | Transaction cardholder token ID | N |
wallet_id
|
string | Transaction cardholder wallet ID | N |
cardholder_postal_code
|
string | Card holder's postal code in support of the Address Verification System (AVS) in Canada and Europe. | Y |
cardholder_street_number
|
string | Card holder's street number in support of the Address Verification System (AVS) in Canada and Europe. | Y |
cardholder_street_address
|
string | Card holder's street address in support of the Address Verification System (AVS) in Canada and Europe. | Y |
match_address
|
bool | If cardholder_street_address and Cardholder_street_number passed in the request matches the customer's street address according to the Pismo database, this flag is set to true, otherwise it is set to false. If no_address_data is true, this field is set to false.
|
N |
match_postal_code
|
bool | If cardholder_postal_code matches the customer's postal code according to the Pismo database, this flag is set to true, otherwise it is set to false. If no_address_data is true, this field is set to false.
|
N |
no_address_data
|
bool | If the customer's is not in the Pismo database and cannot be verified, this flag is set to true, otherwise it is set to false.
|
N |
card_metadata
|
string | Any key-value object, information provided by customer for a specific card. | N |
account_owner_data
|
array | An array that contains the account owner information (sent by Visa for validation).
This is only required if account_name_request="Y". |
|
account_owner_type
|
string | Account owner type can be PRIMARY or SECONDARY. |
N |
account_owner_name_first
|
string | Primary or secondary account owner's first name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y". |
account_owner_name_middle
|
string | Primary or secondary account owner's middle name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y". |
account_owner_name_last
|
string | Primary or secondary account owner's last name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y". |
additional_service_result_data
|
object | An array that contains the account name request result information.
This is only required if account_name_request="Y". |
|
account_name_request_result
|
string | Indicates if a match was performed. This is only required if accountNameRequest="I". Possible values:
NAME_MATCH_PERFORMED
NAME_MATCH_NOT_PERFORMED
NAME_MATCH_NOT_SUPPORTED
|
|
full_name_account_match_decision
|
string | Match decision value is only required if account_name_request="Y". Possible values:
MATCH
PARTIAL_MATCH
NO_MATCH
UNVERIFIED = when for some reason the validation is not performed.
|
|
last_name_account_match_decision
|
string | Match decision value is only required if account_name_request="Y". Possible values:
MATCH
PARTIAL_MATCH
NO_MATCH
UNVERIFIED = when for some reason the validation is not performed.
|
|
middle_name_account_match_decision
|
string | Match decision value is only required if account_name_request="Y". Possible values:
MATCH
PARTIAL_MATCH
NO_MATCH
UNVERIFIED = when for some reason the validation is not performed.
|
|
first_name_account_match_decision
|
string | Match decision value is only required if account_name_request="Y". Possible values:
MATCH
PARTIAL_MATCH
NO_MATCH
UNVERIFIED = when for some reason the validation is not performed.
|
|
additional_service_request_data
|
object | An array that contains the account name request information. | |
account_name_request
|
string | Determines request for account name information. Possible values:
I - issuer needs to send the name
Y - issuer needs to send matching result
|
| Field | Type | Description | Req |
|---|---|---|---|
is_approved
|
bool | Is transaction approved flag | N |
response_code
|
string | Network two digit response code. For example:
00 = approve
51 = insufficient funds
57 = card not active
96 = system failure, etc. For more information, refer to
Validation codes for authorization events. If approve = false, you can use this value to respond to the network.
|
N |
merchant_denial_code
|
string | The merchant denial code indicates the reason for declined authorizations and the course of action that merchants can take. For example: 02 - Cannot approve at this time 03 - Do not try again |
N |
limit_amount
|
number | Limit available. An ordinary case is balance inquiry. Return null if there is no need to pass it. [entity:"transaction" only] | N |
available_credit_limit
|
object | Balance limit for processing code 30 (balance inquiry) or Voucher authorizations - account_type 70 |
N |
amount
|
number | Available credit limit amount | N |
currency_code
|
integer | ISO 4217 currency code. For example: 986 = Brazilian real. | N |
account_owner_data
|
array | An array that contains the account owner information (sent by Visa for validation).
This is only required if account_name_request="Y". |
|
account_owner_type
|
string | Account owner type can be PRIMARY or SECONDARY. |
N |
account_owner_name_first
|
string | Primary or secondary account owner's first name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y". |
account_owner_name_middle
|
string | Primary or secondary account owner's middle name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y". |
account_owner_name_last
|
string | Primary or secondary account owner's last name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y". |
document_number
|
string | Document number | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories |
address
|
object | Account owner address | Address data is only required with authorization OCT (processing code 26) and when the merchant is from Canada or the U.S. |
street
|
string | Street name for account owner address | Address data is only required with authorization OCT (processing code 26) and when the merchant is from Canada or the U.S. |
number
|
string | Address number for account owner | Address data is only required with authorization OCT (processing code 26) and when the merchant is from Canada or the U.S. |
additional_service_result_data
|
object | An array that contains the account name request result information.
This is only required if account_name_request="Y". |
C |
account_name_request_result
|
string | Indicates if a match was performed. This is only required if accountNameRequest="I". Possible values:
NAME_MATCH_PERFORMED
NAME_MATCH_NOT_PERFORMED
NAME_MATCH_NOT_SUPPORTED
|
C |
full_name_account_match_decision
|
string | Match decision value is only required if account_name_request="Y". Possible values:
MATCH
PARTIAL_MATCH
NO_MATCH
UNVERIFIED = when for some reason the validation is not performed.
|
C |
last_name_account_match_decision
|
string | Match decision value is only required if account_name_request="Y". Possible values:
MATCH
PARTIAL_MATCH
NO_MATCH
UNVERIFIED = when for some reason the validation is not performed.
|
C |
middle_name_account_match_decision
|
string | Match decision value is only required if account_name_request="Y". Possible values:
MATCH
PARTIAL_MATCH
NO_MATCH
UNVERIFIED = when for some reason the validation is not performed.
|
C |
first_name_account_match_decision
|
string | Match decision value is only required if account_name_request="Y". Possible values:
MATCH
PARTIAL_MATCH
NO_MATCH
UNVERIFIED = when for some reason the validation is not performed.
|
C |
match_address
|
bool | If cardholder_street_address and cardholder_street_number passed in the request matches the customer's street address, this flag is set to true, otherwise it is set to false. The value of this field will override Pismo's matching results when informed.If no_address_data is true, this field is not required.
|
N |
match_postal_code
|
bool | If cardholder_postal_code matches the customer's postal code, this flag is set to true, otherwise it is set to false. The value of this field will override Pismo's matching results when informed.If no_address_data is true, this field is not required.
|
N |
no_address_data
|
bool | If the customer's address is not in the system and cannot be verified, this flag is set to true, otherwise it is set to false. The value of this field will override Pismo's matching results when informed.
|
N |
partial_approval_info
|
object | Partial authorization addresses insufficient fund declines at point-of-sale when the available Visa card or account balance is not sufficient to approve a transaction in full. | N |
local_amount
|
number | Amount that was partially approved in the transaction's local currency. | N |
settlement_amount
|
number | Amount that was partially approved in the reconciliation currency. | N |
cardholder_amount
|
number | Amount that was partially approved in the cardholder's local currency. | N |
| Field | Type | Description | Req |
|---|---|---|---|
x-tenant |
string | Organization/tenant ID | N |
x-account-id |
number | Transaction cardholder account ID | N |
Authorization |
string | Access token | N |
x-amount |
number | Transaction amount | N |
| Field | Type | Description | Req |
|---|---|---|---|
id
|
string | Database transaction ID. | Y |
entity
|
string | Entity type enum:
- transaction
|
Y |
fields
|
object | Fields submitted through zero balance anti-fraud ingress requests. Please note that each entity type has some exclusive fields. Those fields have an additional note between [] ). | Y |
mti
|
string | Message type ID. For example:0100 = auth. request 0110 = auth. response 0120 = auth. adviceFor more information, refer to MTI. |
Y |
card_id
|
int | Transaction cardholder card ID | Y |
card_status
|
sring | Transaction cardholder card status:
NORMALINOPERATIVEBLOCKEDPENDINGLOSTROBBEDEXPIREDDAMAGEDFRAUDWARNINGCANCELEDCREATEDUNBOUND DELETEDBROKENRENAME CLIENT_ORDER SHAVED RELIEF_LOSS THEFT UNRECEIVED DEFECT INCORRECT_NAME REISSUED UNKNOWN
|
Y |
card_expiration_date
|
string | Transaction cardholder card expiration date. Format = YYYY-MM-DD | Y |
card_type
|
string | Transaction cardholder card type enum:
PLASTIC
VIRTUAL
TEMPORARY
RECURRING
|
N |
card_mode_type
|
string | Card type enum:
CREDIT
DEBIT
MULTIPLE
COMBO
|
Y |
pin_validated
|
boolean | Indicates whether or not the PIN was validated during online authorization. This can be TRUE or FALSE. | Y |
token_id
|
int | Transaction cardholder token ID | N |
wallet_id
|
string | Transaction cardholder wallet ID | N |
device_id_wallet
|
string | Transaction cardholder device ID | N |
account_id
|
int | Transaction cardholder account ID | Y |
authorization_code
|
string | Authorization code | Y |
nsu
|
string | Authorization Network Settlement Utility (NSU) number - tracks the flow of funds between parties involved in a payment card transaction, including the bank, the merchant, and the card network. Different payment card networks may have their own NSU systems, (e.g., Visa - VisaNet, Mastercard - BankNet), or they may use a third party. |
N |
advice_reason_code
|
string | If this is an advice, the reason code. For more information about the Advice reason code (DE 60 subfield 01) and Advice detail code (DE 60 subfield 02) refer to the network manual, Mastercard for example: Customer Interface Specification (2020-MasterCard-CustomerInterfaceSpecification.pdf). | N |
advice_detail_code
|
string | If this is an advice, the detail code. | Y |
amount_transaction
|
number | Transaction amount converted to the cardholder's billing currency | Y |
amount_local
|
number | Transaction amount in merchant local currency | Y |
transaction_timestamp
|
string | Transaction date and hour (format: yyyy-MM-ddThh:mm:ss) | Y |
amount_settlement
|
number | Transaction amount in U.S. dollars | Y |
payment_card_brand
|
string | null | Transaction brand:
Visa or
Mastercard.
|
N |
currency
|
string | Transaction country currency code - ISO 4217. For example,
840 (US) and
986 (Brazil).
|
Y |
merchant_id_code
|
string | Merchant code as registered at the payments network database (Visa/Mastercard) | N |
merchant_name
|
string | Merchant name as registered at the payments network database (Visa/Mastercard) | N |
merchant_city
|
string | Merchant city as registered at the payments network database (Visa/Mastercard) | N |
merchant_state_or_country_code
|
string | Merchant country code outside USA OR Merchant state code from the USA OR Canadian province code from Canada (Note: Canadian merchants can either be represented through the province code or the Canadian country code) | N |
merchant_terminal_id
|
string | Terminal ID at acquirer database | N |
security_cnp_transaction
|
string | Electronic commerce security indicator | N |
atc_chip
|
string | Application Transaction Counter acquired from ISO8583 formatted payments network message | N |
atc_database
|
string | null | Application Transaction Counter acquired from authorization platform database. Comma-separated array of numbers, for example "[1, 3, 6]". | N |
entry_mode
|
string | Method used for PAN entry to initiate a transaction and the PIN entry capabilities. This field is required and must have 3 or 4 digits. For example, try
901 or
9010 for magnetic stripe transaction simulation.
|
Y |
mcc
|
string | Merchant category codes payments network | N |
country_code
|
string | Card issuer location's country code - ISO 3166-1 | N |
postal_code
|
string | Card issuer location's postal code | N |
chip_cryptogram_information_data
|
string | null | Relevant information data from cardholder chip | N |
chip_transaction_date
|
string | null | Transaction date from cardholder chip. Format = YYMMDD. | N |
chip_transaction_type
|
string | Specific transaction type | N |
chip_amount_authorized
|
string | null | Amount authorized for cardholder (format: 000000000010) | N |
chip_transaction_currency_code
|
string | null | Specific given currency code | N |
chip_application_interchange_profile
|
string | null | Application interchange profile information | N |
chip_terminal_country_code
|
string | null | Terminal country code from payment network | N |
chip_cardholder_verification_method
|
string | null | Cardholder authorization verification method | N |
chip_terminal_capabilities
|
string | null | Capability code given by POS. Each code has the list of capabilities classified. | N |
chip_amount_other
|
string | null | If there is no cash back amount, the value of 9F03 is zero. 9F03 may be absent, or present with a zero value. (If there is a cash back amount, presence is mandatory). | N |
chip_application_transaction_counter
|
string | null | DE 120 (record data) contains Application Transaction Counter file data when DE 101 (file name) contains MCC109 | N |
cardholder_postal_code
|
string | null | Cardholder postal code | N |
transaction_type
|
string| null | Processing code that describes the transaction type being authorized | N |
terminal_capability
|
string | null | Point-of-sale (POS) entry mode code | N |
tvr
|
string | null | Terminal verification results - serves as notification of bit validation errors detected in the TVR within the issuer application data during M/Chip Cryptogram Validation processing. | N |
cvr
|
string | null | Card verification results - serves as notification of bit validation errors detected in the CVR within the issuer application data during M/Chip Cryptogram Validation processing. | N |
number_of_installments
|
int | Authorization's number of installments | N |
available_limit
|
number | Available amount limit for payment mode authorized | N |
network_score
|
string | Payment network score - empty field when no information is present | N |
pos_postal_code
|
string | Terminal machine authorizer postal code | N |
acquirer_code
|
string | Authorizer acquirer code | N |
cpf
|
string | Transaction cardholder document number | N |
total_limit
|
number | Total amount limit for payment mode authorized | N |
max_credit_limit
|
number | Maximum credit amount approved for this account | N |
denial_code
|
string | Code that identifies reason if this transaction is denied | N |
response_code
|
string | Network two-digit response code. For example:00 = approve51 = insufficient funds57 = card not active96 = system failure, etc.For more information, refer to Validation codes for authorization events. If approve =
false, you can use this value to respond to the network.
|
Y |
last_referral_reason
|
string | null | Anti-fraud system's last referral reason | N |
id_last_referral_reason
|
string | null | Anti-fraud system's last referral ID reason | N |
cvv_data
|
bool | Is CVV data present flag | N |
cvv_response
|
bool | Does CVV have a valid response flag | N |
unlock_date
|
string | Last card history unlock date | N |
password_present
|
bool | Is password used flag | N |
original_network_data
|
object | Raw ISO-8583 message without sensitive fields | R |
last_four_digits
|
string | Card last four PAN digits | N |
bin
|
string | Card BIN (bank identification number) | N |
program_id
|
integer | Program ID | N |
pin_validation_offline
|
bool | Is pin validation executed offline flag | N |
validation_results
|
object array | Performed validations list | N |
name
|
string | Validation ID | N |
status
|
string | Execution status:
APPROVED,
REJECTED, or
SKIPPED.
|
N |
reason
|
string | Reason enum. For more information, refer to the authorization list of rules guide. | N |
description
|
string | Describes the validation result in a textual form. This field should not be used as a key. It is only to help you understand the validation result. | N |
additional_data
|
object | This optional field contains important additional information related to the validation. You can use this information for your own monitoring. For example, you can monitor custom denial codes using the additional_data field of the Flex controls validation rule. |
N |
transaction_mode
|
string | Transaction mode - credit or debit | N |
three_domain_security
|
object | Three domain security information | N |
service_indicator
|
string | Service indicator ID, corresponding to DE48 SE71 on Mastercard or F126 S20 on Visa. | Y |
electronic_commerce_indicator
|
string | Electronic commerce indicator ID, corresponding to DE48 SE42 on Mastercard or F60 S08 on Visa. | Y |
cardholder_authentication
|
string | Cardholder authentication method, corresponding to DE48 SE43 on Mastercard or F44 S13 on Visa. | Y |
authentication_data
|
string | Cardholder authentication method, corresponding to DE48 SE66 on Mastercard or F126 S09 on Visa. | Y |
account
|
object | An array that contains the account information for the primary owner (sent by Visa for validation).
This is only required if account_name_request="I". |
|
id
|
number | Account ID of the primary owner | N |
first_name
|
string | Primary account owner's first name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
middle_name
|
string | Primary account owner's middle name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
last_name
|
string | Primary account owner's last name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
document_number
|
string | Document number | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories. |
address
|
object | Address information for primary account owner | |
postal_code
|
string | Postal code for primary account owner | |
number
|
string | Address number for primary account owner | |
street
|
string | street name for primary account owner | |
customer
|
object | An array that contains the account information for the secondary owner (sent by Visa for validation). | |
id
|
number | Account ID of the secondary owner | N |
first_name
|
string | Secondary account owner's first name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
middle_name
|
string | Secondary account owner's middle name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
last_name
|
string | Secondary account owner's last name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
document_number
|
string | Document number | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories. |
| Field | Type | Description | Req |
|---|---|---|---|
approve
|
bool | Anti-fraud response after check for transaction fraud. | N |
force_approve
|
bool | Force approval flag - enables the client's anti-fraud system to take precedence over the Pismo authorization system decision. If true and the account lacks sufficient funds, authorization is forced and the account will be negative. | N |
response_code
|
string | Network two digit response code. For example:
00 = approve,
51 = insufficient funds,
57 = card not active,
96 = system failure, etc. For more information, see
Validation codes for authorization events. If approve = false, you can use this value to respond to the network.
|
N |
metadata |
object | Is sent as part of a network authorizations event (metadata field) without filtering. | N |
account
|
object array | An array that contains the account information for the primary owner (sent by Visa for validation).
This is only required if account_name_request="I". |
|
id
|
number | Account ID of the primary owner | N |
first_name
|
string | Primary account owner's first name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
middle_name
|
string | Primary account owner's middle name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
last_name
|
string | Primary account owner's last name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
document_number
|
string | Document number | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories. |
customer
|
object array | An array that contains the account information for the secondary owner (sent by Visa for validation).
This is only required if account_name_request="I". |
|
id
|
number | Account ID of the secondary owner | N |
first_name
|
string | Secondary account owner's first name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
middle_name
|
string | Secondary account owner's middle name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
last_name
|
string | Secondary account owner's last name | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y. |
document_number
|
string | Document number | This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories. |
validation_results
|
object | Performed validations list.
This is only required if account_name_request="I". |
|
name
|
object | Name validation for primary and secondary account owners | |
account
|
object | Name information for primary account owner | |
full_name
|
string | Possbile responses:
MATCH
NO_MATCH
PARTIAL_MATCH
UNVERIFIED
| |
last_name
|
string | Possbile responses:
MATCH
NO_MATCH
PARTIAL_MATCH
UNVERIFIED
| |
middle_name
|
string | Possbile responses:
MATCH
NO_MATCH
PARTIAL_MATCH
UNVERIFIED
| |
first_name
|
string | Possbile responses:
MATCH
NO_MATCH
PARTIAL_MATCH
UNVERIFIED
| |
customer
|
object | Name information for secondary account owner | |
full_name
|
string | Possbile responses:
MATCH
NO_MATCH
PARTIAL_MATCH
UNVERIFIED
| |
last_name
|
string | Possbile responses:
MATCH
NO_MATCH
PARTIAL_MATCH
UNVERIFIED
| |
middle_name
|
string | Possbile responses:
MATCH
NO_MATCH
PARTIAL_MATCH
UNVERIFIED
| |
first_name
|
string | Possbile responses:
MATCH
NO_MATCH
PARTIAL_MATCH
UNVERIFIED
| |
address
|
object | Address validation for account owner | |
postal_code
|
string | Possbile responses:
MATCH
NO_MATCH
PARTIAL_MATCH
UNVERIFIED
| |
street
|
string | Possbile responses:
MATCH
NO_MATCH
PARTIAL_MATCH
UNVERIFIED
| |
number
|
string | Possbile responses:
MATCH
NO_MATCH
PARTIAL_MATCH
UNVERIFIED
|