# Simulate authorization

You can use this endpoint to simulate a real-world authorization from the network in the sandbox environment. This simulation does not go through all the card network services as it would in production, but it does check for card status and balance. The call gives you a chance to see how Pismo might respond to a network authorization. The fields returned can be used to cancel or confirm the request with this endpoint.

You can also use this endpoint to cancel (total or partial) the simulated authorization in the EXT/HOMOLOG environment. To cancel in the production environments, use the [Cancel authorization](ref:cancel-network-authorizations) endpoint.

This endpoint generates the simulated [Network authorization received](https://developers.pismo.io/events/docs/networktransactions-network-authorization-1) event which you can receive and view. This event occurs in production when the Pismo platform cancels or confirms an authorization.  You can also use this endpoint to test connectivity to your [anti-fraud webhook url](doc:anti-fraud-integration).

For more information, see the [Simulate authorizations](doc:simulate-authorizations) guide.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Card issuing - Authorization",
    "version": "1.0.0",
    "description": "Model for network-authorizations-api development - v1.0",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io",
      "description": "Sandbox API server for testing"
    },
    {
      "url": "https://api-networktransactions-http-ext.pismolabs.io",
      "description": "Sandbox API server for migration testing"
    }
  ],
  "tags": [
    {
      "name": "Authorizations"
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "components": {
    "parameters": {
      "TenantHeader": {
        "in": "header",
        "name": "x-tenant",
        "description": "Organization/tenant ID",
        "schema": {
          "type": "string",
          "example": "TN-beaecb37-d149-4674-a485-af0d11e40d85"
        }
      }
    },
    "schemas": {
      "AdviceReasonCode": {
        "type": "string",
        "description": "If this is an *advice*, this is 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. For example, the specification for Mastercard can be found in the section \"Customer Interface Specification (2020-MasterCard-CustomerInterfaceSpecification.pdf)\".  \n"
      },
      "AuthorizationResponse": {
        "type": "object",
        "description": "Authorization response for a credit or debit purchase.",
        "properties": {
          "mti": {
            "$ref": "#/components/schemas/MTI"
          },
          "authorization_code": {
            "type": "string",
            "description": "Authorization code.",
            "example": "F0JR9H"
          },
          "response_code": {
            "$ref": "#/components/schemas/ResponseCode"
          },
          "authorization_date_time": {
            "type": "string",
            "description": "Authorization date and time in Coordinated Universal Time (UTC), i.e., 2020-01-01T10:10:00.000-03:00.",
            "example": "2020-01-01T10:10:00.000-03:00"
          },
          "custom_code": {
            "$ref": "#/components/schemas/CustomCode"
          },
          "match_address": {
            "type": "boolean",
            "description": "Is cardholder address street and number the same as that contained on the platform?",
            "example": true,
            "default": false
          },
          "match_postal_code": {
            "type": "boolean",
            "description": "Is cardholder postal code the same as the one contained on the platform?",
            "example": true,
            "default": false
          },
          "postal_five_digits": {
            "type": "boolean",
            "description": "Is this a valid postal code with five digits?",
            "example": true,
            "default": false
          },
          "no_address_data": {
            "type": "boolean",
            "description": "Is address registered on platform?",
            "example": true,
            "default": false
          },
          "authorization_id": {
            "type": "integer",
            "description": "Authorization ID",
            "example": 4923745
          },
          "account_id": {
            "type": "integer",
            "description": "Account ID",
            "example": 24141240
          },
          "installment_value": {
            "type": "string",
            "description": "Installment value. If there are no installments, this is the same as `contract_amount`.",
            "example": "100.00"
          },
          "interest_rate": {
            "type": "number",
            "description": "Monthly interest rate",
            "example": 2
          },
          "number_of_installments": {
            "type": "number",
            "description": "Number of installments",
            "example": 2
          },
          "contract_amount": {
            "type": "string",
            "description": "Transaction value",
            "example": "100.00"
          },
          "crediario_responses": {
            "type": "array",
            "description": "If there is more than one installment, this is the data for them.",
            "items": {
              "$ref": "#/components/schemas/CrediarioResponse"
            },
            "example": [
              {
                "installmentValue": "51.86",
                "monthlyInterestRate": "2.00",
                "totalAmount": "103.72",
                "numberOfInstallments": "2",
                "feeAmount": "0.00",
                "taxesAmount": "0.86",
                "taxesPercentageOfTotalAmount": "0.83",
                "feePercentageOfTotalAmount": "0.00",
                "planType": "",
                "annualInterestRate": "",
                "monthlyTotalEffectiveCost": "",
                "annualTotalEffectiveCost": "",
                "installmentDate": "",
                "insurance": "",
                "insurancePercentageOfTotalAmount": "",
                "other": "",
                "otherPercentageOfTotalAmount": "",
                "totalAmountToMerchant": "",
                "merchantAmountPercentage": "",
                "reservedForFutureUse": ""
              }
            ]
          }
        }
      },
      "ClearingS3path": {
        "type": "string",
        "description": "The clearing settlement file path in the AWS S3 (storage service). This field must be used when the `mti` field equals `clearing` (representing the simulation of a clearing settlement file processing).\nThe composition of this field is:\n<tenant>/from<KNetwork_name>/<specific_clearing_file_name>/<year>/<julian_date>/<file_name>\nWhere:\n- `<tenant>` is the tenant ID, for example, `TN-c9cccb07-41f7-493c-b796-60cc880bff4f`\n- `<Network_name>` is the name of the card network, for example, Visa, Mastercard, TecBan, etc.\n- `<specific_clearing_file_name>` is the name of the clearing file, for example, ServiceB, Base II, T112, T464, and so on.\n- `<year>` is the year of the clearing file, for example, 2023.\n- `<julian_date>` is the Julian date of the clearing file, for example, 105, where 10 is the day and 5 is the month.\n- `<file_name>` is the name of the clearing file, for example, 17275501C489639.txt.\n",
        "example": "TN-c9cccb07-41f7-493c-b796-60cc880bff4f/fromVisa/C489639/baseii/2023/105/17275501C489639.txt"
      },
      "CreateAuthorization": {
        "type": "object",
        "description": "Creates an authorization",
        "properties": {
          "card_id": {
            "type": "number",
            "description": "Transaction card ID",
            "example": 1234567
          },
          "entry_mode": {
            "type": "string",
            "description": "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, `901` or `9010` for magnetic stripe transaction simulation.\n",
            "example": "901"
          },
          "local_amount": {
            "type": "number",
            "description": "Local transaction amount in the currency of the place where the authorization is requested.",
            "example": 100.5
          },
          "local_currency": {
            "type": "string",
            "maxLength": 3,
            "description": "Local ISO 4217 currency code number where transaction occurred. For example, 986 (Brazil) or 840 (US).",
            "example": "986"
          },
          "merchant": {
            "type": "object",
            "description": "Merchant details",
            "properties": {
              "name": {
                "type": "string",
                "description": "Merchant name"
              },
              "city": {
                "type": "string",
                "description": "Merchant city name"
              },
              "country": {
                "type": "string",
                "description": "Merchant country code in ISO 3166 format. For example, `BR` or `BRA` (Brazil)."
              },
              "code": {
                "type": "string",
                "description": "Merchant code"
              },
              "id": {
                "type": "string",
                "description": "Merchant ID"
              }
            },
            "required": [
              "name"
            ],
            "example": {
              "name": "merchantName",
              "city": "São Paulo",
              "country": "BR",
              "code": "5542",
              "id": "merchantId"
            }
          },
          "mti": {
            "$ref": "#/components/schemas/MTI"
          },
          "bin": {
            "type": "string",
            "description": "A bank identification number (BIN) represents the first four to eight digits on a credit card and identifies the financial institution that issued the card.",
            "example": "587498"
          },
          "processing_code": {
            "type": "string",
            "description": "Transaction's effect on the customer account and the type of accounts affected. For purchase, use \"00\"; for withdraw, use \"01\"; for refund, use \"20\"; for payment, use \"28\".\n\nFor information about processing codes, refer to [Processing codes](https://developers.pismo.io/pismo-docs/docs/processing-codes-and-transaction-types).\n",
            "enum": [
              "00",
              "01",
              "20",
              "28"
            ],
            "example": "00"
          },
          "atc": {
            "type": "string",
            "description": "Application transaction counter (ATC). The chip card application maintains and increments this counter. The ATC provides a sequential reference for each transaction. For more information, refer to [Application Transaction Counter (ATC)](https://developers.pismo.io/pismo-docs/docs/application-transaction-counter-atc).\n",
            "example": "0100"
          },
          "settlement_amount": {
            "type": "number",
            "description": "Settlement amount—**must** be the transaction amount in dollar currency.",
            "example": 10.5
          },
          "settlement_currency": {
            "type": "string",
            "description": "Settlement ISO 4217 currency code",
            "example": "840"
          },
          "cardholder_billing_amount": {
            "type": "number",
            "description": "Transaction amount in cardholder currency",
            "example": 11.5
          },
          "cardholder_billing_currency": {
            "type": "string",
            "description": "Cardholder ISO 4217 currency code",
            "example": "840"
          },
          "account_type": {
            "type": "string",
            "description": "Authorization mode being simulated. Use `20` for debit simulation and `30` for credit simulation.",
            "example": "20"
          },
          "invoice_address": {
            "type": "string",
            "description": "Invoice address",
            "example": "Avenue Five, 222"
          },
          "authorization_code": {
            "type": "string",
            "description": "Authorization code",
            "example": "ABCDEF"
          },
          "retrieval_reference_number": {
            "type": "string",
            "description": "Merchant POS system generated number",
            "example": "5600001085571"
          },
          "nsu": {
            "$ref": "#/components/schemas/NSU"
          },
          "processing_julian_date": {
            "type": "string",
            "description": "Reconciliation processing date. Format = YYDDD. **REQUIRED** for clearing simulations.",
            "example": "25147"
          },
          "acquirer_reference_number": {
            "type": "string",
            "description": "Acquirer generated number",
            "example": "1234569876541"
          },
          "airport_tax": {
            "type": "number",
            "description": "Boarding fee—in a purchase with installments, this value is present at first installment. In a purchase without installments, this value should not be sent since it is included in the authorization amount.\n",
            "example": 3.5
          },
          "message_number": {
            "type": "string",
            "description": "Message number assigned to a clearing message. This **must** be a numeric and sequential number.",
            "example": "123"
          },
          "clearing_s3_path": {
            "$ref": "#/components/schemas/ClearingS3path"
          },
          "transaction_identifier": {
            "type": "string",
            "description": "Transaction ID",
            "example": "589256582795978"
          },
          "simule_tokenized_transaction": {
            "type": "boolean",
            "description": "Does the simulation use a tokenized transaction?",
            "enum": [
              false,
              true
            ],
            "example": true,
            "default": false
          },
          "cash_back_amount": {
            "type": "number",
            "description": "Cash back amount used to simulate purchase with cash back",
            "example": 2
          },
          "advice_reason_code": {
            "$ref": "#/components/schemas/AdviceReasonCode"
          },
          "advice_detail_code": {
            "type": "string",
            "description": "Advice detail code",
            "example": "0004"
          },
          "wallet_identifier": {
            "type": "string",
            "description": "Wallet ID",
            "example": "618"
          }
        },
        "required": [
          "card_id",
          "mti",
          "local_amount",
          "local_currency",
          "entry_mode",
          "merchant"
        ],
        "example": {
          "card_id": 4926027,
          "mti": "0100",
          "local_amount": 100.5,
          "local_currency": "986",
          "entry_mode": "901",
          "merchant": {
            "name": "merchantName"
          }
        }
      },
      "InstallmentAuthorization": {
        "type": "object",
        "description": "Create an installment authorization",
        "properties": {
          "caller": {
            "type": "string",
            "description": "Name of the network that performed this authorization request",
            "example": "MASTERCARD, VISA, or TECBAN"
          },
          "card_id": {
            "type": "number",
            "description": "Identifier of the card used for the transaction.",
            "example": 1234567
          },
          "mti": {
            "type": "string",
            "description": "Message type indicator that defines which flows are going to be performed, such as authorization, cancellation, or clearing",
            "example": "0100"
          },
          "local_amount": {
            "type": "number",
            "description": "Local transaction amount—the amount in the currency of the place where the authorization is requested",
            "example": 100.5
          },
          "local_currency": {
            "type": "string",
            "description": "Local currency code number where transaction occurred",
            "enum": [
              "986",
              "840"
            ]
          },
          "entry_mode": {
            "type": "string",
            "description": "Indicates the method used for PAN entry to initiate a transaction and the PIN entry capabilities",
            "example": "901"
          },
          "processing_code": {
            "type": "string",
            "description": "Describes the effect of a transaction on the customer account and the type of accounts affected. For purchase, use `00`; for withdraw, use `01`; for refund, use `20`; for payment, use `28`.\n\nFor information about processing codes, refer to [Processing code](docs:processing-codes-and-transaction-types).          \n",
            "enum": [
              "00",
              "01",
              "20",
              "28"
            ],
            "example": "00"
          },
          "installments": {
            "type": "object",
            "description": "If this is a credit authorization, this field is required to deal with installments.",
            "properties": {
              "number": {
                "type": "number",
                "description": "Number of installments"
              },
              "with_interest": {
                "type": "string",
                "description": "Indicates if the installment has an interest rate."
              },
              "payment_number": {
                "type": "number",
                "description": "Current installment number"
              },
              "amount_of_each_installment": {
                "type": "number",
                "description": "Amount of each installment"
              }
            },
            "example": {
              "number": 4,
              "with_interest": "true",
              "payment_number": 2,
              "amount_of_each_installment": 50
            }
          },
          "merchant": {
            "type": "object",
            "description": "Details about the merchant",
            "properties": {
              "name": {
                "type": "string",
                "description": "Merchant name"
              },
              "city": {
                "type": "string",
                "description": "Merchant city name"
              },
              "country": {
                "type": "string",
                "description": "Merchant country code"
              },
              "code": {
                "type": "string",
                "description": "Merchant code"
              },
              "id": {
                "type": "string",
                "description": "Merchant ID"
              }
            },
            "required": [
              "name"
            ],
            "example": {
              "name": "merchantName",
              "city": "São Paulo",
              "country": "Brazil",
              "code": "BR",
              "id": "merchantId"
            }
          },
          "atc": {
            "type": "string",
            "description": "Application transaction counter",
            "example": "0100"
          },
          "settlement_amount": {
            "type": "number",
            "description": "Settlement amount—this must be the amount of the transaction in Dollar currency.",
            "example": 10.5
          },
          "settlement_currency": {
            "type": "string",
            "description": "Settlement currency",
            "example": "840"
          },
          "cardholder_billing_amount": {
            "type": "number",
            "description": "Amount of the transaction in the Cardholder currency",
            "example": 11.5
          },
          "cardholder_billing_currency": {
            "type": "string",
            "description": "Currency code of the cardholder",
            "example": "840"
          },
          "account_type": {
            "type": "string",
            "description": "Defines the mode of the authorization being simulated. Use `20` for debit simulation and `30` for credit simulation.",
            "example": "00"
          },
          "invoice_address": {
            "type": "string",
            "description": "Invoice address",
            "example": "222 Fifth Avenue"
          },
          "authorization_code": {
            "type": "string",
            "description": "Authorization code",
            "example": "ABCDEF"
          },
          "retrieval_reference_number": {
            "type": "string",
            "description": "Number generated by merchant POS systems",
            "example": "5600001085571"
          },
          "nsu": {
            "type": "string",
            "description": "Unique sequence number to identify one transaction",
            "example": "085581"
          },
          "processing_julian_date": {
            "type": "string",
            "description": "Date assigned to the reconciliation processing. This is required for clearing simulations and must have the format YDDD.",
            "example": "1360"
          },
          "acquirer_reference_number": {
            "type": "string",
            "description": "Number generated by Acquirer.",
            "example": "1234569876541"
          },
          "airport_tax": {
            "type": "number",
            "description": "Boarding fee. In a purchase with installment, this value will be present at first installment. In a purchase without installment, this value should not be sent since it should be summed to the authorization amount.",
            "example": 3.5
          },
          "message_number": {
            "type": "string",
            "description": "Message number assigned to a clearing message. It must be a sequential number.",
            "example": "1234"
          },
          "transaction_identifier": {
            "type": "string",
            "description": "Transaction identifier",
            "example": "589256582795978"
          },
          "simule_tokenized_transaction": {
            "type": "boolean",
            "description": "Indicates if the simulation will use a tokenized transaction",
            "enum": [
              false,
              true
            ],
            "example": true
          },
          "cash_back_amount": {
            "type": "number",
            "description": "Cash back amount used to simulate purchase with cash back",
            "example": 2
          },
          "advice_reason_code": {
            "type": "string",
            "description": "Advice reason code",
            "example": "112"
          },
          "advice_detail_code": {
            "type": "string",
            "description": "Advice detail code",
            "example": "0004"
          },
          "wallet_identifier": {
            "type": "string",
            "description": "Wallet identifier",
            "example": "618"
          },
          "bin": {
            "type": "string",
            "description": "BIN represents the Bank Identification Number and corresponds to the first 6 or 8 digits of a card. In general terms, the BIN explains which bank institution issued that card.",
            "example": "82327110"
          }
        },
        "required": [
          "card_id",
          "mti",
          "local_amount",
          "local_currency",
          "entry_mode",
          "merchant"
        ],
        "example": {
          "caller": "mastercard",
          "card_id": 4926027,
          "mti": "0100",
          "local_amount": 100.5,
          "local_currency": "986",
          "entry_mode": "901",
          "merchant": {
            "name": "merchantName"
          }
        }
      },
      "ReplacementAuthorization": {
        "type": "object",
        "description": "Create a replacement authorization",
        "properties": {
          "caller": {
            "type": "string",
            "description": "Name of the network that performed this authorization request",
            "example": "MASTERCARD or VISA"
          },
          "card_id": {
            "type": "number",
            "description": "ID of the card used for the transaction",
            "example": 1234567
          },
          "mti": {
            "type": "string",
            "description": "Message type indicator that defines with flow are going to be performed like authorization, cancellation or clearing",
            "example": "0400"
          },
          "local_amount": {
            "type": "number",
            "description": "Local transaction amount. It is the amount in the currency of the place where the authorization is requested.",
            "example": 100.5
          },
          "local_currency": {
            "type": "string",
            "description": "Local currency code number where transaction occurred",
            "enum": [
              "986",
              "840"
            ]
          },
          "replacement_amount": {
            "type": "number",
            "description": "Replacement transaction amount. This is the value that will be used to replace the original authorization value.",
            "example": 90.5
          },
          "authorization_code": {
            "type": "string",
            "description": "Authorization code",
            "example": "ABCDEF"
          },
          "entry_mode": {
            "type": "string",
            "description": "Indicates the method used for PAN entry to initiate a transaction and the PIN entry capabilities.",
            "example": "051"
          },
          "processing_code": {
            "type": "string",
            "description": "Describes the effect of a transaction on the customer account and the type of accounts affected. For purchase, use `00`; for withdraw, use `01`; for refund, use `20`; for payment, use `28`.",
            "enum": [
              "00",
              "01",
              "20",
              "28"
            ],
            "example": "00"
          },
          "merchant": {
            "type": "object",
            "description": "Details about the merchant",
            "properties": {
              "name": {
                "type": "string",
                "description": "Merchant name"
              },
              "city": {
                "type": "string",
                "description": "Merchant city name"
              },
              "country": {
                "type": "string",
                "description": "Merchant country code"
              },
              "code": {
                "type": "string",
                "description": "Merchant code"
              },
              "id": {
                "type": "string",
                "description": "Merchant ID"
              }
            },
            "required": [
              "name"
            ],
            "example": {
              "name": "merchantName",
              "city": "São Paulo",
              "country": "Brazil",
              "code": "BR",
              "id": "merchantId"
            }
          }
        },
        "required": [
          "card_id",
          "mti",
          "local_amount",
          "local_currency",
          "entry_mode",
          "merchant"
        ]
      },
      "CreateCancelAuthorization": {
        "type": "object",
        "properties": {
          "mti": {
            "$ref": "#/components/schemas/MTI"
          }
        },
        "required": [
          "mti"
        ]
      },
      "CreateCrediarioAuthorization": {
        "type": "object",
        "properties": {
          "installments": {
            "type": "object",
            "description": "If this is a Crediario Authorization, this field is required to deal with installments.",
            "properties": {
              "is_crediario": {
                "type": "boolean",
                "description": "Is this a credit authorization?",
                "default": true
              },
              "number": {
                "type": "number",
                "description": "Number of installments"
              },
              "with_interest": {
                "type": "boolean",
                "description": "Does the installment have an interest rate?",
                "default": true
              }
            },
            "example": {
              "is_crediario": true,
              "number": 2,
              "with_interest": true
            }
          }
        }
      },
      "CreateRefundAuthorization": {
        "type": "object",
        "properties": {
          "processing_code": {
            "type": "string",
            "description": "Processing code for refund/credit authorization",
            "example": "20"
          }
        }
      },
      "CreateWithdrawAuthorization": {
        "type": "object",
        "properties": {
          "processing_code": {
            "type": "string",
            "description": "Processing code for international withdrawal",
            "example": "01"
          }
        }
      },
      "CrediarioResponse": {
        "type": "object",
        "description": "Data related to installments",
        "properties": {
          "installmentValue": {
            "type": "string",
            "description": "Installment value",
            "example": "51.86"
          },
          "monthlyInterestRate": {
            "type": "string",
            "description": "Monthly interest rate",
            "example": "2.00"
          },
          "totalAmount": {
            "type": "string",
            "description": "Total amount",
            "example": "103.72"
          },
          "numberOfInstallments": {
            "type": "string",
            "description": "Number of installments",
            "example": "2"
          },
          "feeAmount": {
            "type": "string",
            "description": "Fee amount",
            "example": "0.00"
          },
          "taxesAmount": {
            "type": "string",
            "description": "Taxes amount",
            "example": "0.86"
          },
          "taxesPercentageOfTotalAmount": {
            "type": "string",
            "description": "Taxes percentage of total amount",
            "example": "0.83"
          },
          "feePercentageOfTotalAmount": {
            "type": "string",
            "description": "Fee percentage of total amount",
            "example": "0.00"
          },
          "planType": {
            "type": "string",
            "description": "Plan type - with interest (20), without interest(21) or a crediario type(25)",
            "example": "20"
          },
          "annualInterestRate": {
            "type": "string",
            "description": "Annual interest rate",
            "example": "10.2"
          },
          "monthlyTotalEffectiveCost": {
            "type": "string",
            "description": "Monthly total effective cost",
            "example": "1.40"
          },
          "annualTotalEffectiveCost": {
            "type": "string",
            "description": "Aannual total effective cost",
            "example": "0.00"
          },
          "installmentDate": {
            "type": "string",
            "description": "Installment date - format = yyyymmdd",
            "example": "20201129"
          },
          "insurance": {
            "type": "string",
            "description": "Insurance",
            "example": "1"
          },
          "insurancePercentageOfTotalAmount": {
            "type": "string",
            "description": "Insurance percentage of total amount",
            "example": "2"
          },
          "other": {
            "type": "string",
            "description": "Any other added values, if applicable, that the cardholder is paying",
            "example": ""
          },
          "otherPercentageOfTotalAmount": {
            "type": "string",
            "description": "Other percentage of total amount",
            "example": ""
          },
          "totalAmountToMerchant": {
            "type": "string",
            "description": "Total amount to be paid to merchant (purchase amount)",
            "example": "4"
          },
          "merchantAmountPercentage": {
            "type": "string",
            "description": "Percentage of the total amount to be paid to merchant",
            "example": "0008"
          },
          "reservedForFutureUse": {
            "type": "string",
            "description": "Reserved for future use"
          }
        }
      },
      "CustomCode": {
        "type": "string",
        "description": "Internal custom code generated in authorization flow for declined requests, indicating the reason the request was declined.\n\nFor more information, see [authorization validations](https://developers.pismo.io/pismo-docs/docs/validation-codes-for-authorization-events#authorization-validations).\n",
        "enum": [
          "FL2",
          "FL8",
          "FLB",
          "FLE",
          "DCM",
          "VMN",
          "998",
          "LUD",
          "LUE",
          "LUT",
          "LGE",
          "810",
          "PFT",
          "IAT",
          "BND",
          "ANF",
          "CTE",
          "CED",
          "ZBD",
          "FRB",
          "UBT",
          "FL6",
          "BNF",
          "BNP",
          "BNR",
          "VED",
          "BNU",
          "VEV",
          "UBN",
          "CSU",
          "NPL",
          "OP1",
          "TNF",
          "Z26",
          "Z24",
          "Z29",
          "Z23",
          "Z22"
        ],
        "example": "FLB"
      },
      "MTI": {
        "type": "string",
        "description": "Message type ID. For example: `0100` = auth. request, `0110`` = auth. response, `0120` = auth. advice. For more information, see [MTI](https://en.wikipedia.org/wiki/ISO_8583#Message_type_indicator_(MTI)).\n",
        "nullable": false,
        "example": "0100"
      },
      "NSU": {
        "type": "string",
        "description": "Authorization Network Settlement Utility (NSU) number - tracks the flow of funds between parties involved in a payment card transaction, including the bank, the merchant, and the card network. Different payment card networks may have their own NSU systems, ie, Visa - VisaNet, Mastercard - BankNet, or they may use a third party.\n",
        "example": "15469"
      },
      "ResponseCode": {
        "type": "string",
        "description": "Network two-digit response code. For example: 00 = approve, 51 = insufficient funds, 57 = card not active, 96 = system failure, etc. For more information, see [Validation codes for authorization events](https://developers.pismo.io/pismo-docs/docs/validation-codes-for-authorization-events). If `approve` = `false`, you can use this value to respond to the network.\n",
        "example": "00"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Account access token. Tokens can expire quickly, which can result in an \"Unauthorized\" error.",
        "bearerFormat": "JWT"
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "The request is acceptable but the syntax is malformed, for example, some type number parameter with a text content."
      },
      "404NotFound": {
        "description": "Specified resource was not found"
      },
      "500InternalServerError": {
        "description": "Internal server error"
      }
    }
  },
  "paths": {
    "/networktransactions/v1/authorizations": {
      "post": {
        "summary": "Simulate authorization",
        "description": "You can use this endpoint to simulate a real-world authorization from the network in the sandbox environment. This simulation does not go through all the card network services as it would in production, but it does check for card status and balance. The call gives you a chance to see how Pismo might respond to a network authorization. The fields returned can be used to cancel or confirm the request with this endpoint.\n\nYou can also use this endpoint to cancel (total or partial) the simulated authorization in the EXT/HOMOLOG environment. To cancel in the production environments, use the [Cancel authorization](https://developers.pismo.io/pismo-docs/reference/cancel-network-authorizations) endpoint.\n\nThis endpoint generates the simulated [Network authorization received](https://developers.pismo.io/events/docs/networktransactions-network-authorization-1) event which you can receive and view. This event occurs in production when the Pismo platform cancels or confirms an authorization.  You can also use this endpoint to test connectivity to your [anti-fraud webhook url](https://developers.pismo.io/pismo-docs/docs/anti-fraud-integration).\n\nFor more information, see the [Simulate authorizations](https://developers.pismo.io/pismo-docs/docs/simulate-authorizations) guide.\n",
        "operationId": "post_v1-authorizations",
        "tags": [
          "Authorizations"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/TenantHeader"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/CreateAuthorization"
                  },
                  {
                    "$ref": "#/components/schemas/CreateCrediarioAuthorization"
                  },
                  {
                    "$ref": "#/components/schemas/CreateWithdrawAuthorization"
                  },
                  {
                    "$ref": "#/components/schemas/CreateRefundAuthorization"
                  },
                  {
                    "$ref": "#/components/schemas/CreateCancelAuthorization"
                  },
                  {
                    "$ref": "#/components/schemas/InstallmentAuthorization"
                  },
                  {
                    "$ref": "#/components/schemas/ReplacementAuthorization"
                  }
                ]
              },
              "examples": {
                "Create authorization": {
                  "value": {
                    "caller": "visa",
                    "card_id": 186266181,
                    "mti": "0100",
                    "local_amount": 5,
                    "local_currency": "986",
                    "settlement_amount": 5,
                    "settlement_currency": "840",
                    "entry_mode": "051",
                    "processing_code": "00",
                    "nsu": "0855861",
                    "merchant": {
                      "name": "merchantName",
                      "city": "merchantCity",
                      "country": "GB",
                      "code": "016205",
                      "id": "12121212"
                    }
                  }
                },
                "National purchase": {
                  "value": {
                    "caller": "mastercard",
                    "card_id": 4926027,
                    "mti": "0100",
                    "local_amount": 50.5,
                    "local_currency": "986",
                    "settlement_amount": 50.5,
                    "settlement_currency": "840",
                    "entry_mode": "901",
                    "processing_code": "00",
                    "merchant": {
                      "name": "merchantName"
                    }
                  }
                },
                "National withdrawal": {
                  "value": {
                    "caller": "mastercard",
                    "card_id": 4926027,
                    "mti": "0100",
                    "local_amount": 50.5,
                    "local_currency": "986",
                    "settlement_amount": 50.5,
                    "settlement_currency": "840",
                    "entry_mode": "901",
                    "processing_code": "01",
                    "merchant": {
                      "name": "merchantName"
                    }
                  }
                },
                "Tecban Withdrawal": {
                  "value": {
                    "caller": "tecban",
                    "card_id": 6752905,
                    "mti": "0200",
                    "local_amount": 10,
                    "local_currency": "986",
                    "settlement_amount": 10,
                    "settlement_currency": "840",
                    "retrieval_reference_number": "00000004500000130",
                    "entry_mode": "051",
                    "account_type": "30",
                    "processing_code": "01",
                    "merchant": {
                      "name": "merchantName"
                    }
                  }
                },
                "Tecban Cancellation Withdrawal": {
                  "value": {
                    "caller": "tecban",
                    "card_id": 6752905,
                    "mti": "0202",
                    "local_amount": 10,
                    "local_currency": "986",
                    "settlement_amount": 10,
                    "settlement_currency": "840",
                    "retrieval_reference_number": "00000004500000130",
                    "entry_mode": "051",
                    "account_type": "30",
                    "processing_code": "01",
                    "authorization_code": "RHRCDM",
                    "response_code": "W4",
                    "merchant": {
                      "name": "merchantName"
                    }
                  }
                },
                "Internacional purchase": {
                  "value": {
                    "caller": "mastercard",
                    "card_id": 4926027,
                    "mti": "0100",
                    "local_amount": 50.5,
                    "local_currency": "840",
                    "settlement_amount": 50.5,
                    "settlement_currency": "840",
                    "entry_mode": "901",
                    "merchant": {
                      "name": "merchantName"
                    },
                    "processing_code": "00"
                  }
                },
                "Internacional withdrawal": {
                  "value": {
                    "caller": "mastercard",
                    "card_id": 4926027,
                    "mti": "0100",
                    "local_amount": 50.5,
                    "local_currency": "840",
                    "settlement_amount": 50.5,
                    "settlement_currency": "840",
                    "entry_mode": "901",
                    "merchant": {
                      "name": "merchantName"
                    },
                    "processing_code": "01"
                  }
                },
                "Crediario authorization": {
                  "value": {
                    "caller": "mastercard",
                    "card_id": 4926027,
                    "mti": "0100",
                    "local_amount": 50.5,
                    "local_currency": "986",
                    "settlement_amount": 50.5,
                    "settlement_currency": "840",
                    "entry_mode": "901",
                    "merchant": {
                      "name": "merchantName"
                    },
                    "installments": {
                      "is_crediario": true,
                      "number": 2,
                      "with_interest": true
                    }
                  }
                },
                "Cancel authorization (partial)": {
                  "value": {
                    "caller": "mastercard",
                    "card_id": 4926027,
                    "mti": "0400",
                    "local_amount": 5,
                    "local_currency": "986",
                    "settlement_amount": 5,
                    "settlement_currency": "840",
                    "entry_mode": "051",
                    "account_type": "20",
                    "processing_code": "00",
                    "nsu": "0855861",
                    "merchant": {
                      "name": "MERCHANT test",
                      "city": "MERCHANT CITY",
                      "country": "BRA",
                      "code": "5199"
                    },
                    "authorization_code": "Z3DDJ7",
                    "replacement_amount": 4,
                    "settlement_replacement_amount": 1
                  }
                },
                "Refund/credit authorization": {
                  "value": {
                    "caller": "mastercard",
                    "card_id": 4926027,
                    "mti": "0400",
                    "local_amount": 50.5,
                    "local_currency": "986",
                    "settlement_amount": 50.5,
                    "settlement_currency": "840",
                    "entry_mode": "901",
                    "processing_code": "00",
                    "merchant": {
                      "name": "merchantName"
                    }
                  }
                },
                "Credit voucher": {
                  "value": {
                    "caller": "mastercard",
                    "card_id": 4926027,
                    "mti": "0100",
                    "local_amount": 50.5,
                    "local_currency": "986",
                    "settlement_amount": 50.5,
                    "settlement_currency": "840",
                    "entry_mode": "901",
                    "processing_code": "20",
                    "merchant": {
                      "name": "merchantName"
                    }
                  }
                },
                "Installment Authorization": {
                  "value": {
                    "caller": "mastercard",
                    "card_id": 4926027,
                    "mti": "0100",
                    "local_amount": 100,
                    "local_currency": "986",
                    "settlement_amount": 100,
                    "settlement_currency": "840",
                    "entry_mode": "071",
                    "processing_code": "00",
                    "account_type": "30",
                    "retrieval_reference_number": "000002",
                    "nsu": "000002",
                    "installments": {
                      "number": 2,
                      "with_interest": true,
                      "payment_number": 1,
                      "amount_of_each_installment": 50
                    },
                    "merchant": {
                      "name": "merchantName",
                      "city": "Teresina",
                      "country": "BRA"
                    }
                  }
                },
                "Replacement Authorization": {
                  "value": {
                    "caller": "mastercard",
                    "card_id": 4926027,
                    "mti": "0400",
                    "local_amount": 100,
                    "local_currency": "986",
                    "settlement_amount": 100,
                    "settlement_currency": "840",
                    "replacement_amount": 90,
                    "authorization_code": "Z3DDJ7",
                    "entry_mode": "071",
                    "processing_code": "00",
                    "account_type": "30",
                    "retrieval_reference_number": "000002",
                    "nsu": "000002",
                    "merchant": {
                      "name": "merchantName",
                      "city": "Teresina",
                      "country": "BRA"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Resource founded",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthorizationResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "404": {
            "$ref": "#/components/responses/404NotFound"
          },
          "500": {
            "$ref": "#/components/responses/500InternalServerError"
          }
        }
      }
    }
  }
}
```