Client webhooks
Webhooks are user-defined HTTP callbacks that customers can code to interact with the Pismo platform during certain operations. Client webhooks should be registered with Pismo during setup. Talk to your Pismo representative about getting these implemented.
Pismo webhook security
For information on webhook security, refer to Verifying webhook requests.
Client anti-fraud webhook for card tokenization
As a card issuer, you can provide your own anti-fraud card verification via a webhook that Pismo calls during the tokenization process. If you don't provide one, Pismo uses a default anti-fraud method. You need to configure this webhook with your Pismo representative.
You can:
- Approve a card
- Not approve a card
- Ask Pismo to prompt the cardholder for further identity and verification in the form of SMS, phone call, or app.
For more information, refer to Card tokenization process and onboarding and Card tokenization flow and events.
Webhook specifications
Request fields
<Table align={["left","left","left","left"]}>
<thead>
<tr>
<th style={{ textAlign: "left" }}>
Field
</th>
<th style={{ textAlign: "left" }}>
Type
</th>
<th style={{ textAlign: "left" }}>
Description
</th>
<th style={{ textAlign: "left" }}>
Required
</th>
</tr>
</thead>
<tbody>
<tr>
<td style={{ textAlign: "left" }}>
`custom_codes`
</td>
<td style={{ textAlign: "left" }}>
string array
</td>
<td style={{ textAlign: "left" }}>
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.
</td>
<td style={{ textAlign: "left" }}>
No
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`token_id`
</td>
<td style={{ textAlign: "left" }}>
number
</td>
<td style={{ textAlign: "left" }}>
Pismo-issued token ID. You can use this to call the [Get token information](https://developers.pismo.io/pismo-docs/reference/gettokeninfo) endpoint.
</td>
<td style={{ textAlign: "left" }}>
Yes
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`network_brand`
</td>
<td style={{ textAlign: "left" }}>
enum string
</td>
<td style={{ textAlign: "left" }}>
* `vts` - Visa
* `mdes` - Mastercard
</td>
<td style={{ textAlign: "left" }}>
Yes
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`network_call_method`
</td>
<td style={{ textAlign: "left" }}>
enum string
</td>
<td style={{ textAlign: "left" }}>
* `VTS_DEVICE_BINDING`
* `TA`
* `VTS_APPROVE_PROVSIONING`
* `VTS_APPROVE_PROVISIONG_ISO`
</td>
<td style={{ textAlign: "left" }}>
Yes
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`card`
</td>
<td style={{ textAlign: "left" }}>
object
</td>
<td style={{ textAlign: "left" }} />
<td style={{ textAlign: "left" }} />
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`id`
</td>
<td style={{ textAlign: "left" }}>
number
</td>
<td style={{ textAlign: "left" }}>
Pismo-assigned card ID
</td>
<td style={{ textAlign: "left" }}>
Yes
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`type`
</td>
<td style={{ textAlign: "left" }}>
enum string
</td>
<td style={{ textAlign: "left" }}>
Card type:
* `PLASTIC`
* `VIRTUAL`
* `RECURRING`
* `TEMPORARY`
</td>
<td style={{ textAlign: "left" }}>
Yes
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`program_id`
</td>
<td style={{ textAlign: "left" }}>
number
</td>
<td style={{ textAlign: "left" }}>
Program ID
</td>
<td style={{ textAlign: "left" }}>
Yes
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`bin`
</td>
<td style={{ textAlign: "left" }}>
string
</td>
<td style={{ textAlign: "left" }}>
Bank identification number
</td>
<td style={{ textAlign: "left" }}>
Yes
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`status`
</td>
<td style={{ textAlign: "left" }}>
enum string
</td>
<td style={{ textAlign: "left" }}>
Card status:
* `created`
* `normal`
* `damaged`
* `warning`
* `lost`
* `unknown`
</td>
<td style={{ textAlign: "left" }}>
No
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`stage`
</td>
<td style={{ textAlign: "left" }}>
enum string
</td>
<td style={{ textAlign: "left" }}>
Card lifecycle status
* `unknown`
* `blocked`
* `unblocked`
</td>
<td style={{ textAlign: "left" }}>
No
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`combo_card`
</td>
<td style={{ textAlign: "left" }}>
object
</td>
<td style={{ textAlign: "left" }} />
<td style={{ textAlign: "left" }}>
No
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`status`
</td>
<td style={{ textAlign: "left" }}>
enum string
</td>
<td style={{ textAlign: "left" }}>
Card status:
* `created`
* `normal`
* `damaged`
* `warning`
* `lost`
* `unknown`
</td>
<td style={{ textAlign: "left" }} />
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`original_network_data`
</td>
<td style={{ textAlign: "left" }}>
object
</td>
<td style={{ textAlign: "left" }}>
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. Note: The Mastercard manual requires a Mastercard Connect ID log in for access.
</td>
<td style={{ textAlign: "left" }}>
No
</td>
</tr>
</tbody>
</Table>
<br /><p style={{fontSize: "large", fontWeight: "bold"}}>Custom codes</p>
<p>VTS = Visa, MDES = Mastercard.</p>
| 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 |
Sample request
```json
{
"card":{
"id": 134142,
"type": "PLASTIC",
"program_id": 1234,
"bin": "5122"
},
"combo_card": { },
"token_id": 432,
"network_brand": "vts",
"custom_codes": ["FRB"],
"original_network_data": {
}
}
```
Response fields
<Table align={["left","left","left","left"]}>
<thead>
<tr>
<th style={{ textAlign: "left" }}>
Field
</th>
<th style={{ textAlign: "left" }}>
Type
</th>
<th style={{ textAlign: "left" }}>
Description
</th>
<th style={{ textAlign: "left" }}>
Required
</th>
</tr>
</thead>
<tbody>
<tr>
<td style={{ textAlign: "left" }}>
**`approve`**
</td>
<td style={{ textAlign: "left" }}>
boolean
</td>
<td style={{ textAlign: "left" }}>
Card approved flag
</td>
<td style={{ textAlign: "left" }}>
Yes
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
**`action_code`**
</td>
<td style={{ textAlign: "left" }}>
string
</td>
<td style={{ textAlign: "left" }}>
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
</td>
<td style={{ textAlign: "left" }}>
Yes
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
**`step_up_methods`**
</td>
<td style={{ textAlign: "left" }}>
object array
</td>
<td style={{ textAlign: "left" }}>
Needs challenge methods. At least one is required if used.
</td>
<td style={{ textAlign: "left" }}>
Yes if `action_code` = `85`.
</td>
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`method`
</td>
<td style={{ textAlign: "left" }}>
enum string
</td>
<td style={{ textAlign: "left" }}>
One-time passcode (OTP) challenge method:
* `OTPSMS` - SMS
* `OTPAPP` - App
* `OTPCALL` - Call
</td>
<td style={{ textAlign: "left" }} />
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`value`
</td>
<td style={{ textAlign: "left" }}>
string
</td>
<td style={{ textAlign: "left" }}>
Additional information for challenge - phone number, app, and so on.
</td>
<td style={{ textAlign: "left" }} />
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`platform`
</td>
<td style={{ textAlign: "left" }}>
enum string
</td>
<td style={{ textAlign: "left" }}>
Only used for Visa and only when the method is `OPTAPP`:
* `IOS`
* `ANDROID`
* `WINDOWS`
* `WEB`
</td>
<td style={{ textAlign: "left" }} />
</tr>
<tr>
<td style={{ textAlign: "left" }}>
`source`
</td>
<td style={{ textAlign: "left" }}>
string
</td>
<td style={{ textAlign: "left" }}>
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.
</td>
<td style={{ textAlign: "left" }} />
</tr>
</tbody>
</Table>
Sample response
```json
{
"step_up_methods": [
{
"method": "OTPCALL",
"value": "+551130039500"
},
{
"method": "OTPSMS",
"value": "5327"
},
{
"method": "OTPAPP",
"value": "app",
"source": "com.issuer.banking://wallet",
"platform": "ANDROID"
}
],
"approve": true,
"action_code": "85"
}
```
Anti-fraud code sample (Go)
```Text Anti-fraud code sample
package main
// Anti-fraud code sample in Go
//curl --location --request POST 'http://antifraudhost' \
//--header 'x-pismo-sign: eyJhbGciOiJSUzI1NiIsImtpZCI6IjEzY2VlZWViMWEwNjU1Nzg4Y2UyMDg0ZmZmY2FkMDJmNTFmYzMxNDAiLCJ0eXAiOiJKV1QifQ.eyJhY2NvdW50LWlkIjo5ODY2NTM4NiwiYm9keS1oYXNoIjoiUm0yNWNpTy9RRjNMdmIwL1JZbmVWMFZRUkMzd3pNbzZjemdlR1NHUE1KWT0iLCJleHAiOjE2NTI1MzY2MzAsImlhdCI6MTY1MTY3MjYzMCwiaXNzIjoiYXBpLnBpc21vLmlvIiwia2lkIjoiMTNjZWVlZWIxYTA2NTU3ODhjZTIwODRmZmZjYWQwMmY1MWZjMzE0MCIsInN1YiI6ImFwaS1jYXJkcy10b2tlbml6YXRpb24ifQ.bE7l7KQHRj_0J7zcXtLXgefQuGVQjdUr2BtetTQzTf25_tbHf6iUXHIsGB8iCVujo2e5aUrglxTQScduo3sUuJgzLNUHEyBOgMUc9b6v9K_-reFLpJa9Co0Ct8PmU_os-AZr6jqrYgzGk343I_FYDDw48BmqSMRgwtaJPzHQesaSdd8pjAw_CdSttobstplJjQiwUetufmSvZkOCQHeU-JHTwgdcTwgmtJwVMnFFERIdWQMzoz1UYtP0oMJivw3Zt-MjutqvodkaymOIx9IjJTywp0Oq61rmPtWlKW0pIsI6HCYDR8pASgantt7sXGpNb8cdynUIyvxlixpy77kdfg' \
//--header 'Content-Type: application/json' \
//--data-raw '{
// "card":{
// "id": 134142,
// "type": "PLASTIC"
// },
// "combo_card": null,
// "token_id": 432,
// "network_brand": "vts",
// "custom_codes": ["FRB", "BNB"],
// "original_network_data": {}
//}'
import (
"context"
"crypto/x509"
"encoding/json"
"encoding/pem"
"fmt"
"github.com/labstack/echo/v4"
"github.com/square/go-jose"
"io/ioutil"
"net/http"
)
type clientTokenDecision struct {
Approve bool `json:"approve"`
ActionCode string `json:"action_code"`
StepUpMethods []clientStepUpMethod `json:"step_up_methods"`
}
type clientStepUpMethod struct {
Method string `json:"method"`
Value string `json:"value,omitempty"`
Source string `json:"source"`
Platform string `json:"platform"`
}
func main() {
getPismoCertificates()
e := echo.New()
e.POST("/", handler)
e.Logger.Fatal(e.Start(":1323"))
}
var mapCertificates map[string]*x509.Certificate
func getPismoCertificates() {
url := "https://sandbox.pismolabs.io/v1/certs"
httpReq, err := http.NewRequestWithContext(context.Background(), http.MethodGet, url, nil)
if err != nil {
panic(err)
}
client := http.Client{}
httpRes, err := client.Do(httpReq)
if err != nil {
panic(err)
}
if httpRes.StatusCode != http.StatusOK {
panic(err)
}
bRes, err := ioutil.ReadAll(httpRes.Body)
if err != nil {
panic(err)
}
tmpMap := make(map[string]string)
err = json.Unmarshal(bRes, &tmpMap)
if err != nil {
panic(err)
}
mapCertificates = make(map[string]*x509.Certificate)
for key, val := range tmpMap {
block, _ := pem.Decode([]byte(val))
if block == nil {
panic("cannot decode block")
}
cer, err := x509.ParseCertificate(block.Bytes)
if err != nil {
panic(err)
}
mapCertificates[key] = cer
}
}
func handler(c echo.Context) error {
tokenString := c.Request().Header.Get("X-Pismo-Sign")
valid := isTokenValid(tokenString)
if !valid {
return fmt.Errorf("certificate not valid")
}
k := clientTokenDecision{
Approve: true,
ActionCode: "85",
StepUpMethods: []clientStepUpMethod{
{
Method: "OTPAPP",
Value: "app.to.app",
},
{
Method: "OTPSMS",
},
},
}
return c.JSON(http.StatusOK, k)
}
func isTokenValid(tokenString string) bool {
jwsSignature, err := jose.ParseSigned(tokenString)
if err != nil {
return false
}
for _, sign := range jwsSignature.Signatures {
kid := sign.Header.KeyID
cert := mapCertificates[kid]
_, err := jwsSignature.Verify(cert.PublicKey)
if err != nil {
return false
}
break
}
return true
}
```
Client anti-fraud webhook for banking transaction
This webhook is called during banking operations such as instant pay transactions. Specifically, it would be called during the processing for the following endpoints:
- Pix-out transfer
- Pix reversal
- Pay bank slip
- Perform cash-out (integrated payments)
Webhook specifications
Request fields
<HTMLBlock>{`
<table>
<tr style="background-color: lightgrey;">
<th>Field</th>;
<th>Type</th>
<th>Description</th>
<th>Req</th>
</tr>
<tr>
<td>
<code>decision</code>
</td>
<td>string</td>
<td>Pismo decision<br>Enum: [ "<code>approve</code>". "<code>reject</code>" ]</td>
<td>Y</td>
</tr>
<tr>
<td>
<code>id</code>
</td>
<td>string</td>
<td>Request ID</td>
<td>Y</td>
</tr>
<tr>
<td>
<code>datetime</code>
</td>
<td>string</td>
<td>Call datetime in ISO 8601 format</td>
<td>Y</td>
</tr>
<tr>
<td>
<code>account_id</code>
</td>
<td>string</td>
<td>Pismo account ID</td>
<td>Y</td>
</tr>
<tr>
<td>
<code>currency_code</code>
</td>
<td>string</td>
<td> ISO 4217 currency code. For example: 986=Brazil, 840=US.</td>
<td>Y</td>
</tr>
<tr>
<td>
<code>amount</code>
</td>
<td>number</td>
<td>Transaction amount</td>
<td>Y</td>
</tr>
<tr>
<td>
<code>origin</code>
</td>
<td>string</td>
<td>Transaction origin:
<br>Enum:[
"<code>banking</code>",
"<code>instant-pay</code>".
"<code>onus</code>"]
</td>
<td>Y</td>
</tr>
<tr>
<td>
<code>operation_type</code>
</td>
<td>string</td>
<td>Operation type:
<br>Enum: [
"<code>cashin</code>",
"<code>cashout</code>" ]
</td>
<td>Y</td>
</tr>
<tr>
<td>
<code>processing_code</code>
</td>
<td>string</td>
<td>Processing code. For more information see
<a href="https://developers.pismo.io/pismo-docs/docs/processing-codes-and-transaction-types">Processing codes and transaction types</a>
</td>
<td>Y</td>
</tr>
<tr style="background-color: beige;">
<td>
<code>entities</code>
</td>
<td>object</td>
<td>Details of entities related to the transaction.</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 30px;">
<code>account</code>
</td>
<td>object</td>
<td>Account information.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>name</code>
</td>
<td>string</td>
<td>Customer name</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>document_number</code>
</td>
<td>string</td>
<td>Customer government document number.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>creation_date</code>
</td>
<td>string</td>
<td>Creation datetime in ISO 8601 format.</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 60px;">
<code>
limits
</code>
</td>
<td>object</td>
<td>Limits</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>total</code>
</td>
<td>number</td>
<td>Total</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 60px;">
<code>
address
</code>
</td>
<td>object</td>
<td>Address information.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>zipcode</code>
</td>
<td>string</td>
<td>Postal code</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 60px;">
<code>
phone
</code>
</td>
<td>object</td>
<td>Phone information.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>area</code>
</td>
<td>string</td>
<td>Area code.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>country</code>
</td>
<td>string</td>
<td>Country code.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 90px;"}>
<code>number</code>
</td>
<td>string</td>
<td>Phone number</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td>
<code>
metadata
</code>
</td>
<td>object</td>
<td>Any JSON name-value pairs</td>
<td>N</td>
</tr>
</tr>
<tr style="background-color: beige;">
<td>
<code>
raw
</code>
</td>
<td>object</td>
<td>Platform additional information forwarded to the anti-fraud system, varies according to origin. Sent only in on-us transactions.</td>
<td>N</td>
</tr>
</table>
`}</HTMLBlock>
Sample request
```json
{
"decision": "approve",
"id": "id",
"datetime": "2022-07-28T12:45:12.566Z",
"account_id": 102334690,
"currency_code": "986",
"amount": 20,
"origin": "banking",
"operation_type": "cashin",
"processing_code": "003100",
"entities": {
"account": {
"name": "Anne Arbor",
"document_number": "8675309",
"creation_date": "2023-01-01T05:00:00.000Z",
"limits": {
"total": 1000
},
"address": {
"zipcode": 8675309
},
"phone": {
"area": "415",
"country": "55",
"number": "8675309"
}
}
},
"metadata": {
"a": false,
"b": 1,
"c": "test",
"d": {
"d1": "4683bf0c-20d2-4a7f-8877-5f3e9b46252c",
"d2": false,
"d3": 15
}
}
}
```
Response fields
<HTMLBlock>{`
<table>
<tr style="background-color: lightgrey";>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Req</th>
</tr>
<tr>
<td>
<code>decision</code>
</td>
<td>string</td>
<td>Client decision
<br>Enum: [ "
<code>approve</code>", "
<code>reject</code>"]
</td>
<td>Y</td>
</tr>
<tr style="background-color: beige;">
<td>
<code>
metadata
</code>
</td>
<td>object</td>
<td>Any JSON name-value pairs</td>
<td>N</td>
</tr>
</table>
`}</HTMLBlock>
Sample response
```json
{
“decision”: “approve”,
“metadata”: {}
}
```
Client webhooks for card transaction authorization
The following webhooks are called, if clients have registered them with Pismo, during the card transaction authorization process. They allow clients to do their own validation and anti-fraud checks in addition to those that Pismo does.
Different webhooks for Full balance and Zero balance
Please note that the following two webhooks - one for Full balance clients and one for Zero balance clients - are not the same and can not be used interchangeably.
For information about the differences between Full balance and Zero balance implementation, refer to the Card network integration guide.
Zero balance validations webhook
This section details how Zero balance customers should code their validations and anti-fraud webhook for the transaction authorization process. The webhook request to Zero balance clients occurs during step 5 in the Full and Zero balance workflows.
Unlike Full balance issuers, Zero balance issuers need to do their own account and limit checks as well as validations and anti-fraud checks. Pismo performs basic card validations for Zero balance customers and, if any of the validations fail, this webhook is not called. This webhook is optional, but if you want to provide one, you should register it during setup.
In the Request and Response fields table Required columns, Y = required, N = not required, C = conditional.
Webhook specifications
Request headers
<HTMLBlock>{`
<table>
<tr style={{backgroundColor: "lightgrey"}}>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Req</th>
</tr>
<tr>
<td><pre>x-tenant</pre></td>
<td>string</td>
<td>Organization/tenant ID</td>
<td>N</td>
</tr>
<tr>
<td><code>x-cid</code></td>
<td>string</td>
<td>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.</td>
<td>N</td>
</tr>
<tr>
<td><code>Authorization</code></td>
<td>string</td>
<td>Access token </td>
<td>N</td>
</tr>
<tr>
<td><code>Content-type</code></td>
<td>string</td>
<td>A specification for a structured, used application/json</td>
<td>N</td>
</tr>
<tr>
<td><code>User-Agent</code></td>
<td>string</td>
<td>The user agent responsible for making a given HTTP request. For example, pismo/http-client.</td>
<td>N</td>
</tr>
</table>
`}</HTMLBlock>
Request fields
<HTMLBlock>{`
<table>
<tr style={{backgroundColor: "lightgrey"}}>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Req</th>
</tr>
<tr>
<td>
<code>id</code>
</td>
<td>string</td>
<td>Database transaction ID</td>
<td>Y</td>
</tr>
<tr>
<td>
<code>entity</code>
</td>
<td>string </td>
<td>Entity type enum:
<br>-
<code>transaction</code>
</td>
<td>Y</td>
</tr >
<tr style="background-color: beige;">
<td>
<code>fields</code>
</td>
<td>object</td>
<td>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 []).</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>mti</code>
</td>
<td>string</td>
<td>Message type ID. For example:
<br><code>0100</code> = auth. request
<br><code>0110</code> = auth. response
<br><code>0120</code> = auth. advice
<br>For more information, refer to
<a href="https://en.wikipedia.org/wiki/ISO_8583#Message_type_indicator_(MTI)" target="_blank">MTI</a>.
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>card_id</code>
</td>
<td>int</td>
<td>Transaction cardholder card ID</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>account_id</code>
</td>
<td>int</td>
<td>Transaction cardholder account ID</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>amount_transaction</code>
</td>
<td>number</td>
<td>Transaction amount in the customer's currency</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>amount_local</code>
</td>
<td>number</td>
<td>Transaction amount in the merchant's local currency</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>transaction_timestamp</code>
</td>
<td>string</td>
<td>Transaction date and hour (format:yyyy-MM-ddThh:mm:ss) local time, no TZ.
<br>This is the <code>data.transaction.localDateTime</code> from the network, fields DE12/DE13, when present.
<br>If DE12/DE13 are not present, this is the authorization's current time, not the real transaction time.
<br>For transmission time, use the UTC DE7 carried as <code>transmission_date_time</code>.</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>amount_settlement</code>
</td>
<td>number</td>
<td>Amount in settlement currency defined by the issuer</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>processing_code</code>
</td>
<td>string</td>
<td>This is the transaction's effect on the customer account and the type of accounts affected.
<br>This is the 6-digit Pismo processing code which identifies financial operations on the Pismo platform.
<br>For more information, refer to the <a href="https://developers.pismo.io/pismo-docs/docs/cc-manage-processing-codes-and-transaction-types"
target="_blank" rel="noopener noreferrer">
Processing codes and transaction types
</a> guide.</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>currency</code>
</td>
<td>string</td>
<td>Transaction country currency code - ISO 4217. For example,
<br><code>840</code> (US)
<br><code>986</code> (Brazil)
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>payment_card_brand</code>
</td>
<td>string | null</td>
<td>Transaction brand -
<code>Visa</code> or
<code>Mastercard</code>.
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>merchant_id_code</code>
</td>
<td>string</td>
<td>Merchant code as registered at the payments network database (Visa/Mastercard)</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>merchant_name</code>
</td>
<td>string</td>
<td>Merchant name as registered at the payments network database (Visa/Mastercard)</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>merchant_city</code>
</td>
<td>string</td>
<td>Merchant city as registered at the payments network database (Visa/Mastercard)</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>merchant_state_or_country_code</code>
</td>
<td>string</td>
<td>Merchant country code outside USA (OR) Merchant state code from the USA (OR) Canadian province code from Canada.
<br>NOTE: Canadian merchants can either be represented through the province code or the canadian country code.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>merchant_terminal_id</code>
</td>
<td>string</td>
<td>Terminal ID at acquirer database</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>atc_chip</code>
</td>
<td>string</td>
<td>Application Transaction Counter acquired from ISO8583 formatted payments network message</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>atc_database</code>
</td>
<td>string | null</td>
<td>Application Transaction Counter acquired from authorization platform database. Comma-separated array of numbers, for example "[1, 3, 6]".</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cvv_data</code>
</td>
<td>string</td>
<td>CVV data</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>entry_mode</code>
</td>
<td>string</td>
<td>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.
<br>For example, try
<code>901</code> or
<code>9010</code> for magnetic stripe transaction simulation.
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>mcc</code>
</td>
<td>string</td>
<td>Merchant category codes payments network.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>card_type</code>
</td>
<td>string</td>
<td>Transaction cardholder card type enum:
<br>
<code>PLASTIC</code>
<br>
<code>VIRTUAL</code>
<br>
<code>TEMPORARY</code>
<br>
<code>RECURRING</code>
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>country_code</code>
</td>
<td>string</td>
<td>Card issuer location's country code - ISO 3166-1</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_validation</code>
</td>
<td>bool</td>
<td>Is chip valid flag</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>postal_code</code>
</td>
<td>string</td>
<td>Card issuer location's postal code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_cryptogram_information_data</code>
</td>
<td>string | null</td>
<td>Relevant information data from cardholder chip</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_transaction_date</code>
</td>
<td>string | null</td>
<td>Transaction date from cardholder chip. Format: <code>yymmdd.</code></td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_transaction_type</code>
</td>
<td>string</td>
<td>Specific transaction type</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_amount_authorized</code>
</td>
<td>string | null</td>
<td>Amount authorized for cardholder. Format: 000000000010)</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_transaction_currency_code</code>
</td>
<td>string | null</td>
<td>Specific given currency code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_application_interchange_profile</code>
</td>
<td>string | null</td>
<td>Application interchange profile information</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_terminal_country_code</code>
</td>
<td>string | null</td>
<td>Terminal country code from payment network.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_cardholder_verification_method</code>
</td>
<td>string | null</td>
<td>Cardholder authorization verification method</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_terminal_capabilities</code>
</td>
<td>string | null</td>
<td>Capability code given by POS. Each code has the list of capabilities classified.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_amount_other</code>
</td>
<td>string | niull</td>
<td>If there is no cash back amount, the value of 9F03 is zero. 9F03 may be absent, or present with a zero value.
<br>If there is a cash back amount, presence is mandatory.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_application_transaction_counter</code>
</td>
<td>string | null</td>
<td>DE 120 (record data) contains Application Transaction Counter file data when DE 101 (file name) contains MCC109</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cardholder_postal_code</code>
</td>
<td>string | null</td>
<td>Cardholder postal code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>transaction_type</code>
</td>
<td>string| null</td>
<td>Processing code that describes the transaction type being authorized.
<br>This processing code is the first 2 characters of the mapped code.
<br><code>"00"</code> for purchases.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>nsu</code>
</td>
<td>string</td>
<td>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.
<br>Different payment card networks may have their own NSU systems (e.g., Visa - VisaNet, Mastercard - BankNet) or they may use a third party.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>retrieval_reference_number</code>
</td>
<td>string</td>
<td>Merchant POS system generated number</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>authorization_code</code>
</td>
<td>string</td>
<td>Authorization code</td>
<td>Y <br> 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.</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>incoming_authorization_code</code>
</td>
<td>string</td>
<td>Authorization code from card network</td>
<td>C <br> 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.</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>response_code</code>
</td>
<td>string</td>
<td>Network two digit response code. For example:
<br><code>00</code> = approve
<br><code>51</code> = insufficient funds
<br><code>57</code> = card not active
<br><code>96</code> = system failure, etc.
<br>For more information, refer to
<a href="https://developers.pismo.io/pismo-docs/docs/validation-codes-for-authorization-events" target="_blank">Validation codes for authorization events</a>.
<br>If
<code>approve</code> =
<code>false</code>, you can use this value to respond to the network.
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>terminal_capability</code>
</td>
<td>string | null</td>
<td>Point-of-sale (POS) entry mode code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>tvr</code>
</td>
<td>string | null</td>
<td>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.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cvr</code>
</td>
<td>string | null</td>
<td>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.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>number_of_installments</code>
</td>
<td>int</td>
<td>Authorization's number of installments</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>network_score</code>
</td>
<td>number</td>
<td>Payment network score: empty field when no information is present.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>pos_postal_code</code>
</td>
<td>string</td>
<td>Terminal machine authorizer postal code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>acquirer_code</code>
</td>
<td>string</td>
<td>Authorizer acquirer code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>denial_code</code>
</td>
<td>string</td>
<td>Code that identifies reason the transaction was denied</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>financial_network_code</code>
</td>
<td>string</td>
<td>Financial code from card network</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>banknet_reference_number</code>
</td>
<td>string</td>
<td>Authorization banknet reference number</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 30px;">
<code>original_network_data</code>
</td>
<td>object</td>
<td>Raw ISO-8583 message without sensitive fields.</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cvv_presence</code>
</td>
<td>bool</td>
<td>Is CVV data present flag</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>password_present</code>
</td>
<td>bool</td>
<td>Is password used flag</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>account_type</code>
</td>
<td>string</td>
<td>Account type:
<br><code>00</code> for non specified
<br><code>10</code> for savings
<br><code>20</code> for checking
<br><code>30</code> for credit card
</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 30px;">
<code>validation_results</code>
</td>
<td>object array</td>
<td>Performed validations list</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>name</code>
</td>
<td>string</td>
<td>Validation ID
<br>See <a href="https://developers.pismo.io/pismo-docs/docs/rule-list#authorization-amounts-calculation" target="_blank">Authorization rule list</a> for more information.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>status</code>
</td>
<td>string</td>
<td>Execution status:
<br><code> APPROVED</code>
<br><code>REJECTED</code>
<br><code>SKIPPED</code>
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>reason</code>
</td>
<td>string</td>
<td>Reason enum
<br>For more information, refer to the
<a href='https://developers.pismo.io/pismo-docs/docs/authorization-validation-rules-for-card-network-operations#list-of-rules' target='_blank'>authorization list of rules</a> guide.
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>description</code>
</td>
<td>string</td>
<td>Human-readable result reason</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>program_id</code>
</td>
<td>integer</td>
<td>Program ID</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>token_id</code>
</td>
<td>integer</td>
<td>Transaction cardholder token ID</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>wallet_id</code>
</td>
<td>string</td>
<td>Transaction cardholder wallet ID</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cardholder_postal_code</code>
</td>
<td>string</td>
<td>Card holder's postal code in support of the Address Verification System (AVS) in Canada and Europe.
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cardholder_street_number</code>
</td>
<td>string</td>
<td>Card holder's street number in support of the Address Verification System (AVS) in Canada and Europe.
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cardholder_street_address</code>
</td>
<td>string</td>
<td>Card holder's street address in support of the Address Verification System (AVS) in Canada and Europe.
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>match_address</code>
</td>
<td>bool</td>
<td>If <code>cardholder_street_address</code> and <code>Cardholder_street_number</code> passed in the request matches the customer's street address according to the Pismo database, this flag is set to <code>true</code>, otherwise it is set to <code>false</code>. If <code>no_address_data</code> is <code>true</code>, this field is set to <code>false</code>.
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>match_postal_code</code>
</td>
<td>bool</td>
<td>If <code>cardholder_postal_code</code> matches the customer's postal code according to the Pismo database, this flag is set to <code>true</code>, otherwise it is set to <code>false</code>. If <code>no_address_data</code> is <code>true</code>, this field is set to <code>false</code>.
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>no_address_data</code>
</td>
<td>bool</td>
<td>If the customer's is not in the Pismo database and cannot be verified, this flag is set to <code>true</code>, otherwise it is set to <code>false</code>.
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>card_metadata</code>
</td>
<td>string</td>
<td>Any key-value object, information provided by customer for a specific card.
</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 30px;">
<code>account_owner_data</code>
</td>
<td>array</td>
<td>An array that contains the account owner information (sent by Visa for validation).
<br>This is only required if account_name_request="Y".</td>
<td> </td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>account_owner_type</code>
</td>
<td>string</td>
<td>Account owner type can be <code>PRIMARY</code> or <code>SECONDARY</code>.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>account_owner_name_first</code>
</td>
<td>string</td>
<td>Primary or secondary account owner's first name</td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y".</td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>account_owner_name_middle</code>
</td>
<td>string</td>
<td>Primary or secondary account owner's middle name</td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y".</td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>account_owner_name_last</code>
</td>
<td>string</td>
<td>Primary or secondary account owner's last name</td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y".</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 60px">
<code>additional_service_result_data</code>
</td>
<td>object</td>
<td>An array that contains the account name request result information.
<br>This is only required if account_name_request="Y".</td>
<td> </td>
</tr>
<tr>
<td style="padding-left: 90px">
<code>account_name_request_result</code>
</td>
<td>string</td>
<td>Indicates if a match was performed. This is only required if accountNameRequest="I". Possible values:
<br><code>NAME_MATCH_PERFORMED</code>
<br><code>NAME_MATCH_NOT_PERFORMED</code>
<br><code>NAME_MATCH_NOT_SUPPORTED</code>
</td>
<td> </td>
</tr>
<tr>
<td style="padding-left: 90px">
<code>full_name_account_match_decision</code>
</td>
<td>string</td>
<td>Match decision value is only required if account_name_request="Y". Possible values:
<br><code>MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>NO_MATCH</code>
<br><code>UNVERIFIED</code> = when for some reason the validation is not performed.
</td>
<td> </td>
</tr>
<tr>
<td style="padding-left: 90px">
<code>last_name_account_match_decision</code>
</td>
<td>string</td>
<td>Match decision value is only required if account_name_request="Y". Possible values:
<br><code>MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>NO_MATCH</code>
<br><code>UNVERIFIED</code> = when for some reason the validation is not performed.
</td>
<td> </td>
</tr>
<tr>
<td style="padding-left: 90px">
<code>middle_name_account_match_decision</code>
</td>
<td>string</td>
<td>Match decision value is only required if account_name_request="Y". Possible values:
<br><code>MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>NO_MATCH</code>
<br><code>UNVERIFIED</code> = when for some reason the validation is not performed.
</td>
<td> </td>
</tr>
<tr>
<td style="padding-left: 90px">
<code>first_name_account_match_decision</code>
</td>
<td>string</td>
<td>Match decision value is only required if account_name_request="Y". Possible values:
<br><code>MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>NO_MATCH</code>
<br><code>UNVERIFIED</code> = when for some reason the validation is not performed.
</td>
<td> </td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 30px;">
<code>additional_service_request_data</code>
</td>
<td>object</td>
<td>An array that contains the account name request information.
</td>
<td> </td>
<tr>
<td style="padding-left: 60px">
<code>account_name_request</code>
</td>
<td>string</td>
<td>Determines request for account name information. Possible values:
<br> <code>I</code> - issuer needs to send the name
</br> <code>Y</code> - issuer needs to send matching result
</td>
<td> </td>
</tr>
</table>
`}</HTMLBlock>
Sample request
```json
{
"id": "1111",
"entity": "transaction",
"fields": {
"mti": "0100",
"card_id": 1234,
"account_id": 1234,
"amount_transaction": 10,
"amount_local": 10,
"amount_settlement": 10,
"transaction_timestamp": "2019-05-09 15:52:00",
"processing_code": "00",
"payment_card_brand": "Mastercard",
"currency": "986",
"merchant_id_code": "687555537877464",
"merchant_name": "PISMO",
"merchant_city": "SAO PAULO",
"merchant_state_or_country_code": "BRA",
"merchant_terminal_id": "12300004",
"atc_chip": "43",
"atc_database": "[748,652,998]",
"cvv_data": "CVV_PRESENT",
"entry_mode": "string",
"mcc": "string",
"card_type": "PLASTIC",
"country_code": "076",
"chip_validation": true,
"postal_code": "31404",
"chip_cryptogram_information_data": "80",
"chip_transaction_date": "190425",
"chip_transaction_type": "string",
"chip_amount_authorized": "000000000010",
"chip_transaction_currency_code": "0076",
"chip_application_interchange_profile": "0076",
"chip_terminal_country_code": "076",
"chip_cardholder_verification_method": "420300",
"chip_terminal_capabilities": "E0F0C8",
"chip_amount_other": "string",
"chip_application_transaction_counter": "3900",
"cardholder_postal_code": 12345,
"transaction_type": "00",
"nsu": "15469",
"retrieval_reference_number": "5600001085571",
"authorization_code": "ABCD12",
"incoming_authorization_code": "ABCD12",
"response_code": "00",
"terminal_capability": "string",
"tvr": "0000248000",
"cvr": "0110A040002A00000000000000000000FF",
"number_of_installments": 3,
"network_score": "0",
"pos_postal_code": "22222222",
"acquirer_code": "string",
"denial_code": "CED",
"financial_network_code": "ABC",
"banknet_reference_number": "123456",
"cvv_presence": true,
"password_present": true,
"original_network_data": "...",
"account_type": "30",
"validation_results": [
{
"name": "ARQC",
"status": "APPROVED",
"reason": "NO_CRYPTOGRAM",
"description": "No cryptogram present"
}
],
"program_id": 0,
"token_id": 1234,
"wallet_id": "1234",
"cardholder_street_number": 999,
"cardholder_street_address": "Production St.",
"match_address": true,
"match_postal_code": true,
"no_address_data": false
},
"card_metadata": {
"olalongerkey1": "helloworld",
"olalongerkey2": {
"FgHiJ": "nestedValue2",
"aBcDe": "nestedValue1"
},
"olalongerkey3": "helloworld",
"olalongerkey4": {
"kLmNo": "nestedValue1",
"pQrSt": "nestedValue2"
},
"olalongerkey5": "helloworld",
"account_owner_data": [
{
"account_owner_type": "PRIMARY_OWNER",
"account_owner_name_first": "FirstName",
"account_owner_name_middle": "MiddleName",
"account_owner_name_last": "LastName",
"additional_service_result_data": {
"account_name_request_result": "NAME_MATCH_PERFORMED",
"full_name_account_match_decision": "MATCH",
"last_name_account_match_decision": "MATCH",
"middle_name_account_match_decision": "MATCH",
"first_name_account_match_decision": "MATCH"
}
}
],
"additional_service_request_data": {
"account_name_request": "I"
}
}
}
```
Response fields
<HTMLBlock>{`
<table>
<tr style={{backgroundColor: "lightgrey"}}>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Req</th>
</tr>
<tr>
<td>
<code>is_approved</code>
</td>
<td>bool</td>
<td>Is transaction approved flag</td>
<td>N</td>
</tr>
<tr>
<td>
<code>response_code</code>
</td>
<td>string</td>
<td>Network two digit response code. For example:
<br><code>00</code> = approve
<br><code>51</code> = insufficient funds
<br><code>57</code> = card not active
<br><code>96</code> = system failure, etc. For more information, refer to
<a href="https://developers.pismo.io/pismo-docs/docs/validation-codes-for-authorization-events" target="_blank">Validation codes for authorization events</a>. If <code>approve</code> = <code>false</code>, you can use this value to respond to the network.
</td>
<td>N</td>
</tr>
<tr>
<td>
<code>merchant_denial_code</code>
</td>
<td>string</td>
<td>The merchant denial code indicates the reason for declined authorizations and the course of action that merchants can take.<br>
For example:<br>
02 - Cannot approve at this time<br>
03 - Do not try again
</td>
<td>N</td>
</tr>
<tr>
<td>
<code>limit_amount</code>
</td>
<td>number</td>
<td>Limit available. An ordinary case is balance inquiry. Return null if there is no need to pass it. [entity:"transaction" only]</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td>
<code>available_credit_limit</code>
</td>
<td>object</td>
<td>Balance limit for processing code 30 (balance inquiry) <br> or <br> Voucher authorizations - account_type 70</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>amount</code>
</td>
<td>number</td>
<td>Available credit limit amount</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>currency_code</code>
</td>
<td>integer</td>
<td>ISO 4217 currency code. For example: 986 = Brazilian real.</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 30px;">
<code>account_owner_data</code>
</td>
<td>array</td>
<td>An array that contains the account owner information (sent by Visa for validation).
<br>This is only required if account_name_request="Y".</td>
<td> </td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>account_owner_type</code>
</td>
<td>string</td>
<td>Account owner type can be <code>PRIMARY</code> or <code>SECONDARY</code>.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>account_owner_name_first</code>
</td>
<td>string</td>
<td>Primary or secondary account owner's first name</td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y".</td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>account_owner_name_middle</code>
</td>
<td>string</td>
<td>Primary or secondary account owner's middle name</td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y".</td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>account_owner_name_last</code>
</td>
<td>string</td>
<td>Primary or secondary account owner's last name</td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest="Y".</td>
</tr>
<tr>
<td style="padding-left: 60px">
<code>document_number</code>
</td>
<td>string</td>
<td>Document number</td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 60px">
<code>address</code>
</td>
<td>object</td>
<td>Account owner address
</td>
<td>Address data is only required with authorization OCT (processing code 26) and when the merchant is from Canada or the U.S. </td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>street</code>
</td>
<td>string</td>
<td>Street name for account owner address
</td>
<td>Address data is only required with authorization OCT (processing code 26) and when the merchant is from Canada or the U.S. </td>
</tr>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>number</code>
</td>
<td>string</td>
<td>Address number for account owner
</td>
<td>Address data is only required with authorization OCT (processing code 26) and when the merchant is from Canada or the U.S. </td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 60px">
<code>additional_service_result_data</code>
</td>
<td>object</td>
<td>An array that contains the account name request result information.
<br>This is only required if account_name_request="Y".</td>
<td>C</td>
</tr>
<tr>
<td style="padding-left: 90px">
<code>account_name_request_result</code>
</td>
<td>string</td>
<td>Indicates if a match was performed. This is only required if accountNameRequest="I". Possible values:
<br><code>NAME_MATCH_PERFORMED</code>
<br><code>NAME_MATCH_NOT_PERFORMED</code>
<br><code>NAME_MATCH_NOT_SUPPORTED</code>
</td>
<td>C</td>
</tr>
<tr>
<td style="padding-left: 90px">
<code>full_name_account_match_decision</code>
</td>
<td>string</td>
<td>Match decision value is only required if account_name_request="Y". Possible values:
<br><code>MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>NO_MATCH</code>
<br><code>UNVERIFIED</code> = when for some reason the validation is not performed.
</td>
<td>C</td>
</tr>
<tr>
<td style="padding-left: 90px">
<code>last_name_account_match_decision</code>
</td>
<td>string</td>
<td>Match decision value is only required if account_name_request="Y". Possible values:
<br><code>MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>NO_MATCH</code>
<br><code>UNVERIFIED</code> = when for some reason the validation is not performed.
</td>
<td>C</td>
</tr>
<tr>
<td style="padding-left: 90px">
<code>middle_name_account_match_decision</code>
</td>
<td>string</td>
<td>Match decision value is only required if account_name_request="Y". Possible values:
<br><code>MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>NO_MATCH</code>
<br><code>UNVERIFIED</code> = when for some reason the validation is not performed.
</td>
<td>C</td>
</tr>
<tr>
<td style="padding-left: 90px">
<code>first_name_account_match_decision</code>
</td>
<td>string</td>
<td>Match decision value is only required if account_name_request="Y". Possible values:
<br><code>MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>NO_MATCH</code>
<br><code>UNVERIFIED</code> = when for some reason the validation is not performed.
</td>
<td>C</td>
</tr>
<tr>
<td>
<code>match_address</code>
</td>
<td>bool</td>
<td>If <code>cardholder_street_address</code> and <code>cardholder_street_number</code> passed in the request matches the customer's street address, this flag is set to <code>true</code>, otherwise it is set to <code>false</code>. The value of this field will override Pismo's matching results when informed.<br>
<br>If <code>no_address_data</code> is <code>true</code>, this field is not required.
</td>
<td>N</td>
</tr>
<tr>
<td>
<code>match_postal_code</code>
</td>
<td>bool</td>
<td>If <code>cardholder_postal_code</code> matches the customer's postal code, this flag is set to <code>true</code>, otherwise it is set to <code>false</code>. The value of this field will override Pismo's matching results when informed.<br>
<br>If <code>no_address_data</code> is <code>true</code>, this field is not required.
</td>
<td>N</td>
<tr>
<td>
<code>no_address_data</code>
</td>
<td>bool</td>
<td>If the customer's address is not in the system and cannot be verified, this flag is set to <code>true</code>, otherwise it is set to <code>false</code>. The value of this field will override Pismo's matching results when informed.
</td>
<td>N</td>
</tr>
</tr>
<tr style="background-color: beige;">
<td>
<code>partial_approval_info</code>
</td>
<td>object</td>
<td>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. </td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>local_amount</code>
</td>
<td>number</td>
<td>Amount that was partially approved in the transaction's local currency.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>settlement_amount</code>
</td>
<td>number</td>
<td>Amount that was partially approved in the reconciliation currency.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cardholder_amount</code>
</td>
<td>number</td>
<td>Amount that was partially approved in the cardholder's local currency.</td>
<td>N</td>
</tr>
<tr>
</table>
`}</HTMLBlock>
Sample response
```json
{
"is_approved": true,
"response_code": "00",
"merchant_denial_code": "03",
"limit_amount": 12.34,
"account_owner_data": [
{
"account_owner_type": "PRIMARY_OWNER",
"account_owner_name_first": "Abbie",
"account_owner_name_middle ": "Beth",
"account_owner_name_last": "Norman",
"document_number": "83493028"
},
{
"account_owner_type": "SECONDARY_OWNER",
"account_owner_name_first": "John",
"account_owner_name_middle": "Wade",
"account_owner_name_last": "Garrison",
"document_number": "83493028"
}
],
"address": {
"street": "Av. del Libertador",
"number": 174
},
"additional_service_result_data": {
"account_name_request_result": "NAME_MATCH_PERFORMED",
"full_name_account_match_decision ": "MATCH",
"last_name_account_match_decision": "MATCH",
"middle_name_account_match_decision ": "NO_MATCH",
"first_name_account_match_decision": "PARTIAL_MATCH"
},
"match_address": true,
"match_postal_code": true,
"no_address_data": false
}
```
Full balance anti-fraud webhook
This section details how Full balance customers should code their anti-fraud webhook for the transaction authorization process. This webhook request to Full balance clients occurs during step 5 in the Full and Zero balance workflows. This webhook is optional, but if you want to provide one, you should register it during setup.
For more information, refer to the Anti-fraud integration guide.
Webhook specifications
Request headers
<HTMLBlock>{`
<table>
<tr style="background-color: lightgrey;">
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Req</th>
</tr>
<tr>
<td><pre>x-tenant</pre></td>
<td>string</td>
<td>Organization/tenant ID</td>
<td>N</td>
</tr>
<tr>
<td><code>x-account-id</code></td>
<td>number</td>
<td>Transaction cardholder account ID</td>
<td>N</td>
</tr>
<tr>
<td><code>Authorization</code></td>
<td>string</td>
<td>Access token </td>
<td>N</td>
</tr>
<tr>
<td><code>x-amount</code></td>
<td>number</td>
<td>Transaction amount</td>
<td>N</td>
</tr>
</table>
`}</HTMLBlock>
Request fields
<HTMLBlock>{`
<table>
<tr style="background-color: lightgrey;">
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Req</th>
</tr>
<tr>
<td>
<code>id</code>
</td>
<td>string</td>
<td>Database transaction ID.</td>
<td>Y</td>
</tr>
<tr>
<td>
<code>entity</code>
</td>
<td>string </td>
<td>Entity type enum:
<br>-
<code>transaction</code>
</td>
<td>Y</td>
</tr>
<tr style="background-color: beige;">
<td>
<code>fields</code>
</td>
<td>object</td>
<td>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 [] ).</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>mti</code>
</td>
<td>string</td>
<td>Message type ID. For example:<br>
<code>0100</code> = auth. request <br>
<code>0110</code> = auth. response <br>
<code>0120</code> = auth. advice<br> For more information, refer to
<a href="https://en.wikipedia.org/wiki/ISO_8583#Message_type_indicator_(MTI)" target="_blank">MTI</a>.
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>card_id</code>
</td>
<td>int</td>
<td>Transaction cardholder card ID</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>card_status</code>
</td>
<td>sring</td>
<td>Transaction cardholder card status:
<code>NORMAL</code><br>
<code>INOPERATIVE</code><br>
<code>BLOCKED</code><br>
<code>PENDING</code><br>
<code>LOST</code><br>
<code>ROBBED</code><br>
<code>EXPIRED</code><br>
<code>DAMAGED</code><br>
<code>FRAUD</code><br>
<code>WARNING</code><br>
<code>CANCELED</code><br>
<code>CREATED</code><br>
<code>UNBOUND </code><br>
<code>DELETED</code><br>
<code>BROKEN</code><br>
<code>RENAME </code><br>
<code>CLIENT_ORDER </code><br>
<code>SHAVED </code><br>
<code>RELIEF_LOSS </code><br>
<code>THEFT </code><br>
<code>UNRECEIVED </code><br>
<code>DEFECT </code><br>
<code>INCORRECT_NAME </code><br>
<code>REISSUED </code><br>
<code>UNKNOWN</code>
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>card_expiration_date</code>
</td>
<td>string</td>
<td>Transaction cardholder card expiration date. Format = YYYY-MM-DD</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>card_type</code>
</td>
<td>string</td>
<td>Transaction cardholder card type enum:
<br>
<code>PLASTIC</code>
<br>
<code>VIRTUAL</code>
<br>
<code>TEMPORARY</code>
<br>
<code>RECURRING</code>
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>card_mode_type</code>
</td>
<td>string</td>
<td>Card type enum:
<br>
<code>CREDIT</code>
<br>
<code>DEBIT</code>
<br>
<code>MULTIPLE</code>
<br>
<code>COMBO</code>
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>pin_validated</code>
</td>
<td>boolean</td>
<td>Indicates whether or not the PIN was validated during online authorization. This can be TRUE or FALSE.
</td>
<td>Y</td>
</tr>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>token_id</code>
</td>
<td>int</td>
<td>Transaction cardholder token ID</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>wallet_id</code>
</td>
<td>string</td>
<td>Transaction cardholder wallet ID</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>device_id_wallet</code>
</td>
<td>string</td>
<td>Transaction cardholder device ID</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>account_id</code>
</td>
<td>int</td>
<td>Transaction cardholder account ID</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>authorization_code</code>
</td>
<td>string</td>
<td>Authorization code</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>nsu</code>
</td>
<td>string</td>
<td>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.<br>
Different payment card networks may have their own NSU systems, (e.g., Visa - VisaNet, Mastercard - BankNet), or they may use a third party.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>advice_reason_code</code>
</td>
<td>string</td>
<td>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).</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>advice_detail_code</code>
</td>
<td>string</td>
<td>If this is an advice, the detail code.</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>amount_transaction</code>
</td>
<td>number</td>
<td>Transaction amount converted to the cardholder's billing currency</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>amount_local</code>
</td>
<td>number</td>
<td>Transaction amount in merchant local currency</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>transaction_timestamp</code>
</td>
<td>string</td>
<td>Transaction date and hour (format: yyyy-MM-ddThh:mm:ss)</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>amount_settlement</code>
</td>
<td>number</td>
<td>Transaction amount in U.S. dollars</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>payment_card_brand</code>
</td>
<td>string | null</td>
<td>Transaction brand:
<code>Visa</code> or
<code>Mastercard</code>.
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>currency</code>
</td>
<td>string</td>
<td>Transaction country currency code - ISO 4217. For example,
<code>840</code> (US) and
<code>986</code> (Brazil).
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>merchant_id_code</code>
</td>
<td>string</td>
<td>Merchant code as registered at the payments network database (Visa/Mastercard)</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>merchant_name</code>
</td>
<td>string</td>
<td>Merchant name as registered at the payments network database (Visa/Mastercard)</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>merchant_city</code>
</td>
<td>string</td>
<td>Merchant city as registered at the payments network database (Visa/Mastercard)</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>merchant_state_or_country_code</code>
</td>
<td>string</td>
<td>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)</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>merchant_terminal_id</code>
</td>
<td>string</td>
<td>Terminal ID at acquirer database</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>security_cnp_transaction</code>
</td>
<td>string</td>
<td>Electronic commerce security indicator</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>atc_chip</code>
</td>
<td>string</td>
<td>Application Transaction Counter acquired from ISO8583 formatted payments network message</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>atc_database</code>
</td>
<td>string | null</td>
<td>Application Transaction Counter acquired from authorization platform database. Comma-separated array of numbers, for example "[1, 3, 6]".</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>entry_mode</code>
</td>
<td>string</td>
<td>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
<code>901</code> or
<code>9010</code> for magnetic stripe transaction simulation.
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>mcc</code>
</td>
<td>string</td>
<td>Merchant category codes payments network</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>country_code</code>
</td>
<td>string</td>
<td>Card issuer location's country code - ISO 3166-1</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>postal_code</code>
</td>
<td>string</td>
<td>Card issuer location's postal code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_cryptogram_information_data</code>
</td>
<td>string | null</td>
<td>Relevant information data from cardholder chip</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_transaction_date</code>
</td>
<td>string | null</td>
<td>Transaction date from cardholder chip. Format = YYMMDD.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_transaction_type</code>
</td>
<td>string</td>
<td>Specific transaction type</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_amount_authorized</code>
</td>
<td>string | null</td>
<td>Amount authorized for cardholder (format: 000000000010)</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_transaction_currency_code</code>
</td>
<td>string | null</td>
<td>Specific given currency code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_application_interchange_profile</code>
</td>
<td>string | null</td>
<td>Application interchange profile information</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_terminal_country_code</code>
</td>
<td>string | null</td>
<td>Terminal country code from payment network</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_cardholder_verification_method</code>
</td>
<td>string | null</td>
<td>Cardholder authorization verification method</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_terminal_capabilities</code>
</td>
<td>string | null</td>
<td>Capability code given by POS. Each code has the list of capabilities classified.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_amount_other</code>
</td>
<td>string | null</td>
<td>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).</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>chip_application_transaction_counter</code>
</td>
<td>string | null</td>
<td>DE 120 (record data) contains Application Transaction Counter file data when DE 101 (file name) contains MCC109</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cardholder_postal_code</code>
</td>
<td>string | null</td>
<td>Cardholder postal code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>transaction_type</code>
</td>
<td>string| null</td>
<td>Processing code that describes the transaction type being authorized</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>terminal_capability</code>
</td>
<td>string | null</td>
<td> Point-of-sale (POS) entry mode code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>tvr</code>
</td>
<td>string | null</td>
<td>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.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cvr</code>
</td>
<td>string | null</td>
<td>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.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>number_of_installments</code>
</td>
<td>int</td>
<td>Authorization's number of installments</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>available_limit</code>
</td>
<td>number</td>
<td>Available amount limit for payment mode authorized</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>network_score</code>
</td>
<td>string</td>
<td>Payment network score - empty field when no information is present</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>pos_postal_code</code>
</td>
<td>string</td>
<td>Terminal machine authorizer postal code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>acquirer_code</code>
</td>
<td>string</td>
<td>Authorizer acquirer code</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cpf</code>
</td>
<td>string</td>
<td>Transaction cardholder document number</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>total_limit</code>
</td>
<td>number</td>
<td>Total amount limit for payment mode authorized</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>max_credit_limit</code>
</td>
<td>number</td>
<td>Maximum credit amount approved for this account</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>denial_code</code>
</td>
<td>string</td>
<td>Code that identifies reason if this transaction is denied</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>response_code</code>
</td>
<td>string</td>
<td>Network two-digit response code. For example:<br>
<code>00</code> = approve<br>
<code>51</code> = insufficient funds<br>
<code>57</code> = card not active<br>
<code>96</code> = system failure, etc.<br>
For more information, refer to
<a href="https://developers.pismo.io/pismo-docs/docs/validation-codes-for-authorization-events" target="_blank">Validation codes for authorization events</a>. <br>
If
<code>approve</code> =
<code>false</code>, you can use this value to respond to the network.
</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>last_referral_reason</code>
</td>
<td>string | null</td>
<td>Anti-fraud system's last referral reason</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>id_last_referral_reason</code>
</td>
<td>string | null</td>
<td>Anti-fraud system's last referral ID reason</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cvv_data</code>
</td>
<td>bool</td>
<td>Is CVV data present flag</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>cvv_response</code>
</td>
<td>bool</td>
<td>Does CVV have a valid response flag</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>unlock_date</code>
</td>
<td>string</td>
<td>Last card history unlock date</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>password_present</code>
</td>
<td>bool</td>
<td>Is password used flag</td>
<td>N</td>
</tr>
<tr
style="background-color: beige;">
<td style="padding-left: 30px;">
<code>original_network_data</code>
</td>
<td>object</td>
<td>Raw ISO-8583 message without sensitive fields</td>
<td>Y</td>
</tr>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>last_four_digits</code>
</td>
<td>string</td>
<td>Card last four PAN digits</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>bin</code>
</td>
<td>string</td>
<td>Card BIN (bank identification number)</td>
<td>N</td>
</tr>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>program_id</code>
</td>
<td>integer</td>
<td>Program ID</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>pin_validation_offline</code>
</td>
<td>bool</td>
<td>Is pin validation executed offline flag</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 30px;">
<code>validation_results</code>
</td>
<td>object array</td>
<td>Performed validations list</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>name</code>
</td>
<td>string</td>
<td>Validation ID</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>status</code>
</td>
<td>string</td>
<td>Execution status:
<code> APPROVED</code>,
<code>REJECTED</code>, or
<code>SKIPPED</code>.
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>reason</code>
</td>
<td>string</td>
<td>Reason enum. For more information, refer to the
<a href="https://developers.pismo.io/pismo-docs/docs/authorization-validation-rules-for-card-network-operations#list-of-rules" target="_blank">authorization list of rules</a> guide.
</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>description</code>
</td>
<td>string</td>
<td>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.</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 60px;">
<code>additional_data</code>
</td>
<td>object</td>
<td>This optional field contains important additional information related to the validation. You can use this information for your own monitoring. <br>For example, you can monitor custom denial codes using the additional_data field of the <a href="https://developers.pismo.io/pismo-docs/docs/rule-list#flex-controls-validation" target="_blank">Flex controls validation rule</a>.</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>transaction_mode</code>
</td>
<td>string</td>
<td>Transaction mode - credit or debit</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 30px;">
<code>three_domain_security</code>
</td>
<td>object</td>
<td>Three domain security information</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>service_indicator</code>
</td>
<td>string</td>
<td>Service indicator ID, corresponding to DE48 SE71 on Mastercard or F126 S20 on Visa.</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>electronic_commerce_indicator</code>
</td>
<td>string</td>
<td>Electronic commerce indicator ID, corresponding to DE48 SE42 on Mastercard or F60 S08 on Visa.</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>cardholder_authentication</code>
</td>
<td>string</td>
<td>Cardholder authentication method, corresponding to DE48 SE43 on Mastercard or F44 S13 on Visa.</td>
<td>Y</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>authentication_data</code>
</td>
<td>string</td>
<td>Cardholder authentication method, corresponding to DE48 SE66 on Mastercard or F126 S09 on Visa.</td>
<td>Y</td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 30px;">
<code>account</code>
</td>
<td>object</td>
<td>An array that contains the account information for the primary owner (sent by Visa for validation).
<br>This is only required if account_name_request="I".</td>
<td> </td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>id</code>
</td>
<td>number</td>
<td>Account ID of the primary owner</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>first_name</code>
</td>
<td>string</td>
<td>Primary account owner's first name </td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>middle_name</code>
</td>
<td>string</td>
<td>Primary account owner's middle name</td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>last_name</code>
</td>
<td>string</td>
<td>Primary account owner's last name </td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>document_number</code>
</td>
<td>string</td>
<td>Document number
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories. </td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 60px;">
<code>address</code>
</td>
<td>object</td>
<td>Address information for primary account owner
<td> </td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>postal_code</code>
</td>
<td>string</td>
<td>Postal code for primary account owner
<td> </td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>number</code>
</td>
<td>string</td>
<td>Address number for primary account owner
<td> </td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>street</code>
</td>
<td>string</td>
<td>street name for primary account owner
<td> </td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 30px;">
<code>customer</code>
</td>
<td>object</td>
<td>An array that contains the account information for the secondary owner (sent by Visa for validation).</td>
<td> </td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>id</code>
</td>
<td>number</td>
<td>Account ID of the secondary owner</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>first_name</code>
</td>
<td>string</td>
<td>Secondary account owner's first name </td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>middle_name</code>
</td>
<td>string</td>
<td>Secondary account owner's middle name</td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>last_name</code>
</td>
<td>string</td>
<td>Secondary account owner's last name </td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 60px;">
<code>document_number</code>
</td>
<td>string</td>
<td>Document number
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories. </td>
</tr>
<tr>
<td>
<code>disableToken</code>
</td>
<td>
number</td>
<td>
Indicates when token validation has been bypassed. <br>Example: token type <code>06</code> for Visa, token type <code>V</code> for Mastercard.
</td>
<td>No </td>
</tr>
</table>
`}</HTMLBlock>
Sample request
```json
{
"id": "11114444555566667777888899991111222233",
"entity": "transaction",
"fields": {
"mti": "0100",
"card_id": 1234,
"card_status": "NORMAL",
"card_expiration_date": "2026-10-15T00:00:00.000Z",
"card_type": "PLASTIC",
"card_mode_type": "CREDIT",
"pin_validated": "TRUE",
"token_id": 1234,
"wallet_id": "1234",
"device_id_wallet": "1234",
"account_id": 1234,
"authorization_code": "ABCD12",
"nsu": "15469",
"advice_reason_code": "string",
"advice_detail_code": "0110",
"amount_transaction": 10,
"amount_local": 10,
"amount_settlement": 10,
"transaction_timestamp": "2019-05-09 15:52:00",
"payment_card_brand": "Mastercard",
"currency": "986",
"merchant_id_code": "687555537877464",
"merchant_name": "PISMO",
"merchant_city": "SAO PAULO",
"merchant_state_or_country_code": "BRA",
"merchant_terminal_id": "12300004",
"security_cnp_transaction": "123",
"atc_chip": "43",
"atc_database": "[ 748, 652, 998 ]",
"entry_mode": "string",
"mcc": "string",
"country_code": "076",
"postal_code": "31404",
"chip_cryptogram_information_data": "80",
"chip_transaction_date": "190425",
"chip_transaction_type": "string",
"chip_amount_authorized": "000000000010",
"chip_transaction_currency_code": "0076",
"chip_application_interchange_profile": "0076",
"chip_terminal_country_code": "076",
"chip_cardholder_verification_method": "420300",
"chip_terminal_capabilities": "E0F0C8",
"chip_amount_other": "string",
"chip_application_transaction_counter": "3900",
"cardholder_postal_code": "22222222",
"transaction_type": "00",
"terminal_capability": "string",
"tvr": "0000248000",
"cvr": "0110A040002A00000000000000000000FF",
"number_of_installments": 3,
"available_limit": 200.55,
"network_score": 0,
"pos_postal_code": "22222222",
"acquirer_code": "string",
"cpf": "string",
"total_limit": 5000,
"max_credit_limit": 5000,
"denial_code": "CED",
"response_code": "00",
"last_referral_reason": "",
"id_last_referral_reason": "",
"last_referral_unlock_date": "2019-05-09 15:52:00",
"cvv_data": true,
"cvv_response": true,
"unlock_date": "string",
"password_present": true,
"last_four_digits": "string",
"bin": "string",
"program_id": 0,
"pin_validated_offline": true,
"validation_results": [
{
"name": "ARQC",
"status": "APPROVED",
"reason": "NO_CRYPTOGRAM",
"description": "No cryptogram present"
}
],
"transaction_mode": "CREDIT",
"three_domain_security": {
"service_indicator": "S",
"electronic_commerce_indicator": "05",
"cardholder_authentication": "00",
"authentication_data": "0201020590000000000000000000"
},
"account": {
"id": 123,
"first_name": " FirstName ",
"middle_name": "middleName",
"last_name": "lastName",
"document_number": "00000000000000",
"address": {
"postal_code": "",
"number": 999,
"street": "Production St."
}
},
"customer": {
"id": 123,
"first_name": "firstName",
"middle_name": "middleName",
"last_name": "lastName",
"document_number": "00000000000000"
}
}
}
```
Response fields
<HTMLBlock>{`
<table>
<tr style="background-color: lightgrey;">
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Req</th>
</tr>
<tr>
<td>
<code>approve</code>
</td>
<td>bool</td>
<td>Anti-fraud response after check for transaction fraud.</td>
<td>N</td>
</tr>
<tr>
<td>
<code>force_approve</code>
</td>
<td>bool</td>
<td>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.</td>
<td>N</td>
</tr>
<tr>
<td>
<code>response_code</code>
</td>
<td>string</td>
<td>Network two digit response code. For example:
<code>00</code> = approve,
<code>51</code> = insufficient funds,
<code>57</code> = card not active,
<code>96</code> = system failure, etc. For more information, see
<a href="https://developers.pismo.io/pismo-docs/docs/validation-codes-for-authorization-events" target="_blank">Validation codes for authorization events</a>. If <code>approve</code> = <code>false</code>, you can use this value to respond to the network.
</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td><code>metadata</code></td>
<td>object</td>
<td>Is sent as part of a <a href="https://developers.pismo.io/events/docs/networktransactions-network-authorization-1" target="_blank">network authorizations</a> event (metadata field) without filtering.</td>
<td>N</td>
</tr>
<tr style="background-color: beige;">
<td><code>account</code>
</td>
<td>object array</td>
<td>An array that contains the account information for the primary owner (sent by Visa for validation).
<br>This is only required if account_name_request="I".</td>
<td> </td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>id</code>
</td>
<td>number</td>
<td>Account ID of the primary owner</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>first_name</code>
</td>
<td>string</td>
<td>Primary account owner's first name </td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>middle_name</code>
</td>
<td>string</td>
<td>Primary account owner's middle name</td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>last_name</code>
</td>
<td>string</td>
<td>Primary account owner's last name </td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>document_number</code>
</td>
<td>string</td>
<td>Document number
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories. </td>
</tr>
<tr style="background-color: beige;">
<td>
<code>customer</code>
</td>
<td>object array</td>
<td>An array that contains the account information for the secondary owner (sent by Visa for validation).
<br>This is only required if account_name_request="I".</td>
<td> </td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>id</code>
</td>
<td>number</td>
<td>Account ID of the secondary owner</td>
<td>N</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>first_name</code>
</td>
<td>string</td>
<td>Secondary account owner's first name </td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>middle_name</code>
</td>
<td>string</td>
<td>Secondary account owner's middle name</td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>last_name</code>
</td>
<td>string</td>
<td>Secondary account owner's last name </td>
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories and/or if accountNameRequest=Y.</td>
</tr>
<tr>
<td style="padding-left: 30px;">
<code>document_number</code>
</td>
<td>string</td>
<td>Document number
<td>This is only required for transactions that occur between merchant acquirers and issuers in Brazilian territories. </td>
</tr>
<tr style="background-color: beige;">
<td>
<code>validation_results</code>
</td>
<td>object</td>
<td>Performed validations list.
<br>This is only required if account_name_request="I".</td>
<td> </td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 30px;">
<code>name</code>
</td>
<td>object</td>
<td>Name validation for primary and secondary account owners
<td></td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 60px;">
<code>account</code>
</td>
<td>object</td>
<td>Name information for primary account owner
<td></td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>full_name</code>
</td>
<td>string</td>
<td>Possbile responses:
<br><code>MATCH</code>
<br><code>NO_MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>UNVERIFIED</code>
<td></td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>last_name</code>
</td>
<td>string</td>
<td>Possbile responses:
<br><code>MATCH</code>
<br><code>NO_MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>UNVERIFIED</code>
<td></td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>middle_name</code>
</td>
<td>string</td>
<td>Possbile responses:
<br><code>MATCH</code>
<br><code>NO_MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>UNVERIFIED</code>
<td></td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>first_name</code>
</td>
<td>string</td>
<td>Possbile responses:
<br><code>MATCH</code>
<br><code>NO_MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>UNVERIFIED</code>
<td></td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 60px;">
<code>customer</code>
</td>
<td>object</td>
<td>Name information for secondary account owner
<td></td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>full_name</code>
</td>
<td>string</td>
<td>Possbile responses:
<br><code>MATCH</code>
<br><code>NO_MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>UNVERIFIED</code>
<td></td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>last_name</code>
</td>
<td>string</td>
<td>Possbile responses:
<br><code>MATCH</code>
<br><code>NO_MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>UNVERIFIED</code>
<td></td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>middle_name</code>
</td>
<td>string</td>
<td>Possbile responses:
<br><code>MATCH</code>
<br><code>NO_MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>UNVERIFIED</code>
<td></td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>first_name</code>
</td>
<td>string</td>
<td>Possbile responses:
<br><code>MATCH</code>
<br><code>NO_MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>UNVERIFIED</code>
<td></td>
</tr>
<tr style="background-color: beige;">
<td style="padding-left: 60px;">
<code>address</code>
</td>
<td>object</td>
<td>Address validation for account owner
<td></td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>postal_code</code>
</td>
<td>string</td>
<td>Possbile responses:
<br><code>MATCH</code>
<br><code>NO_MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>UNVERIFIED</code>
<td></td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>street</code>
</td>
<td>string</td>
<td>Possbile responses:
<br><code>MATCH</code>
<br><code>NO_MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>UNVERIFIED</code>
<td></td>
</tr>
<tr>
<td style="padding-left: 90px;">
<code>number</code>
</td>
<td>string</td>
<td>Possbile responses:
<br><code>MATCH</code>
<br><code>NO_MATCH</code>
<br><code>PARTIAL_MATCH</code>
<br><code>UNVERIFIED</code>
<td></td>
</tr>
</table>
`}</HTMLBlock>
Sample response
```json
{
"approve": true,
"force_approve": true,
"referral": true,
"response_code": "00",
"metadata": {},
"account": {
"id": 123,
"first_name": "firstName",
"middle_name": "middleName",
"last_name": "lastName",
"document_number": "00000000000000"
},
"customer": {
"id": 123,
"first_name": "firstName",
"middle_name": "MiddleName",
"last_name": "lastName",
"document_number": "00000000000000"
},
"validation_results": {
"name": {
"account": {
"full_name": "MATCH",
"last_name": "MATCH",
"middle_name": "NO_MATCH",
"first_name": "PARTIAL_MATCH"
},
"customer": {
"full_name": "MATCH",
"last_name": "MATCH",
"middle_name": "NO_MATCH",
"first_name": "PARTIAL_MATCH"
}
},
"address": {
"postal_code": "MATCH",
"street": "NO_MATCH",
"number": "PARTIAL_MATCH"
}
}
}
```
Examples of the original_network_data field
The original_network_data field contains all fields present in the ISO message coming from the network, except the PCI-sensitive information. The content varies according to the request being processed, where some fields may or may not be present. Refer to your card network's specification to find all possible fields.
Visa
{
"panSource": "MOBILE_BANKING_APP",
"tokenInfo": {
"tokenType": "HCE",
"numberOfActiveTokensForPAN": 0,
"numberOfInactiveTokensForPAN": 0,
"numberOfSuspendedTokensForPAN": 0
},
"deviceInfo": {
"osType": "ANDROID",
"deviceID": "i6LnmH740g4EKb1HC7eyy123",
"osVersion": "14",
"deviceName": "WGlhb21pIC0gMjIxMTEzMTdooo..",
"deviceType": "MOBILEPHONE_OR_TABLET",
"deviceBrand": "POCO",
"deviceModel": "22111317OO",
"deviceNumber": "9806",
"deviceLocation": "-22.69/-43.12",
"deviceIPAddressV4": "45.999.0.12",
"deviceLanguageCode": "por",
"deviceManufacturer": "Xiaomi",
"tokenProtectionMethod": "SOFTWARE"
},
"encryptedData": "*****",
"cardholderInfo": {
"name": "JOHN DOE",
"billingAddress": {},
"expirationDate": {
"year": "2031",
"month": "01"
},
"highValueCustomer": false,
"riskAssessmentScore": "23",
"primaryAccountNumber": "*****"
},
"panReferenceID": "V-3026089583794218905123",
"riskInformation": {
"deviceIMEI": "17",
"deviceTimeZone": "Ameri",
"userAccountAge": "9999",
"visaTokenScore": "04",
"simSerialNumber": "23",
"walletAccountAge": "256",
"accountHolderName": "JOHN DOE",
"deviceSerialNumber": "23",
"riskAssessmentScore": "23",
"visaTokenDecisioning": "00",
"walletProviderPANAge": "0",
"deviceTimeZoneSetting": "NETWORK_SET",
"distinctCardholderNames": "1",
"accountToDeviceBindingAge": "1",
"walletProviderDeviceScore": "3",
"walletProviderReasonCodes": "AG,AO,A0,A2",
"walletProviderAccountScore": "5"
},
"lifeCycleTraceID": 356089583803123,
"tokenReferenceID": "DNITHE352608958380350123",
"tokenRequestorID": "40010075123",
"clientWalletAccountID": "-9c4zaFD8bfEcLX2MAfDLOOO",
"paymentAccountReference": "V0010013026085581472569655123",
"walletAccountEmailAddressHash": "4D76566CD536BD24599AE9AA515960C1F9565FB341631A23A5D772B3CC4D4123"
}
Mastercard
{
"de2_primary_account_number": "[card-hash]",
"de3_processing_code": {
"sf1_cardholder_transaction_type_code": "00",
"sf2_cardholder_from_account_type_code": "30",
"sf3_cardholder_to_account_type_code": "00"
},
"de4_amount_transaction": "000000001000",
"de5_amount_settlement": "000000000251",
"de6_amount_cardholder_billing": "000000001000",
"de7_tranmission_date_and_time": {
"sf1_date": "1110",
"sf2_time": "175808"
},
"de9_conversion_rate_settlement": {
"sf1_decimal_indicator": "7",
"sf2_conversion_rate": "1859259"
},
"de10_conversion_rate_cardholder_billing": {
"sf1_decimal_indicator": "6",
"sf2_cardholderbilling_conversion_rate": "1000000"
},
"de11_stan": "637470",
"de12_time_local_transaction": "145808",
"de13_date_local_transaction": "0727",
"de14_date_expiration": "2704",
"de15_date_settlement": "0727",
"de16_date_conversion": "0726",
"de18_merchant_type": "7994",
"de22_pos_entry_mode": {
"sf1_pos_terminal_pan_entry_mode": "81",
"sf2_pos_terminal_pin_entry_mode": "0"
},
"de28_amount_transaction_fee": {},
"de29_amount_settlement_fee": {},
"de30_amount_transaction_processing_fee": {},
"de31_amount_settlement_processing_fee": {},
"de32_acquiring_institution_id_code": "016800",
"de33_forwarding_institution_id_code": "016800",
"de37_retrieval_reference_number": {
"sf1_transaction_date_and_initiator_discretionary_data": "0727499",
"sf2_terminal_transaction_number": "51999"
},
"de41_card_acceptor_terminal_id": "WA000001",
"de42_card_acceptor_id_code": "00027427823 ",
"de43_card_acceptor_name_location_for_all_transactions": {
"sf1_card_acceptor_name": "MerchantName ",
"sf3_card_acceptor_city": "SAO PAULO ",
"sf5_card_acceptor_state_or_country_code": "BRA"
},
"de48_additional_data_private_user": {
"de48_tcc": "T",
"de48_start": "224",
"de48_size": "123",
"de48SubElements": [
"37",
"42",
"92",
"56",
"75",
"71"
],
"se11_key_exchange_block_data": {},
"se13_mastercard_hosted_mobile_phone_top_up_request_data": {},
"se15_authorization_system_advice_date_and_time": {},
"se18_service_parameters": {},
"se23_payment_initiation_channel": {},
"se25_mastercard_cash_program_data": {},
"se26_wallet_program_data": {},
"se33_pan_mapping_file_information": {},
"se34_atc_information": {},
"se36_visa_mmv": {},
"se37_additional_merchant_data": {
"sf1_payment_facilitador_id": "00000231811",
"sf3_sub_merchant_id": "00027427823 "
},
"se40_eletronic_commerce_merchant_cardholder_certificate_serial_number": {},
"se41_eletronic_commercer_certificate_qualifying_information": {},
"se42_eletronic_commerce_indicator": {
"sf1_eletronic_commerce_security_level_indicator_ucaf_collection_indicator": "910"
},
"se43_ucaf": {},
"se48_mobile_program_indicator": {},
"se49_time_validation_information": {},
"se51_merchant_on_behalf_services": {},
"se55_merchant_fraud_scoring_data": {},
"se56_security_services_additional_data_for_issuers": [
{
"sf1_security_services_indicator": "AQV",
"sf2_security_services_data": "600"
},
{
"sf1_security_services_indicator": "AQS",
"sf2_security_services_data": "408"
},
{
"sf1_security_services_indicator": "AQF",
"sf2_security_services_data": "500"
}
],
"se57_security_services_additional_data_for_acquirers": {},
"se58_atm_additional_data": {},
"se61_pos_data_extended_condition_codes": {},
"se64_transit_program": {},
"se65_terminal_compliant_indicator": {},
"se66_authentication_data": {},
"se67_money_send_information": {},
"se71_onbehalf_services": [
{
"sf1_ob_service": "18",
"sf2_onbehalf_result1": "C",
"sf3_onbehalf_result2": " "
}
],
"se74_additional_processing_information": {},
"se75_fraud_scoring_data": {
"sf1_fraud_score": "036",
"sf2_score_reason_code": "91",
"sf3_rules_score": "036",
"sf4_rules_reason_code1": "91",
"sf5_rules_reason_code2": "00"
},
"se78_payment_service_indicator": {},
"se79_chip_cvr_or_tvr_bit_error_results": {},
"se87_card_validation_code_result_or_cvv2": "U",
"se93_fleet_card_id_request_data": {}
},
"de49_currency_code_transaction": "986",
"de50_currency_code_settlement": "840",
"de51_currency_code_cardholder_billing": "986",
"de55_integrated_circuit_card": {
"sf2_cryptogram_information_data": "80",
"sf3_issuer_application_data": "0120B04009990000000000000000000000FF",
"sf5_terminal_verification_result": "0000048000",
"sf6_transaction_date": "221205",
"sf7_transaction_type": "00",
"sf8_amount_authorized": "000000009910",
"sf9_transaction_currency_code": "0986",
"sf10_application_interchange_profile": "3900",
"sf11_terminal_country_code": "0076",
"sf12_cardholder_verification_method": "420300",
"sf13_terminal_capabilities": "E0F0C8",
"sf23_application_transaction_counter": "0050"
},
"de60_advice_reason_code": {},
"de61_pos_data": {
"sf1_pos_terminal_attendance": "1",
"sf2_reserved_for_future_use": "0",
"sf3_pos_terminal_location": "2",
"sf4_pos_cardholder_presence": "5",
"sf5_pos_card_presence": "1",
"sf6_pos_card_capture_capabilities": "0",
"sf7_pos_transaction_status": "4",
"sf8_pos_transaction_security": "0",
"sf9_reserved_for_future_use": "0",
"sf10_cardholder_activated_terminal_level": "6",
"sf11_pos_card_data_terminal_input_capability_indicator": "0",
"sf12_pos_authorization_life_cycle": "05",
"sf13_pos_country_code_or_submerchant": "076",
"sf14_postal_code_or_submerchant": "01452002 "
},
"de63_network_data": {
"sf1_financial_network_code": "MPL",
"sf2_banknet_reference_number": "JMPDOT"
},
"de90_original_data_elements": {},
"de94_service_indicator": {},
"de95_replacement_amounts": {},
"de97_amount_net_settlement": {},
"de112_additional_data_national_use": {},
"de120_record_data": {},
"de124_member_defined_data": {},
}
Updated 1 day ago
Did this page help you?