---
title: "Create Pre-Evaluation"
method: POST
path: "/v1/antifraud/pre-evaluations"
tags: ["Ecommerce"]
---

# Create Pre-Evaluation

`POST /v1/antifraud/pre-evaluations`

Receives a new transaction for antifraud analysis, its meant to be used before payment authorization.

## Request body

- EcommerceAntiFraud
  - `type` 'Ecommerce', required — Antifraud type
  - `buyer` Buyer, required
    - `id` string — Client custom person identifier
    - `first_name` string — First name. Required if full_name is blank.
    - `last_name` string — Last name. Required if full_name is blank.
    - `full_name` string — Full name. Is required if first_name and last_name are blank
    - `document` Document — Document is required if payment method is Redirection and email is blank.
      - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
      - `number` string, required — Person document number
      - `type` string, required — Person document type
    - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
    - `address` Address
      - `address` string, required — Company address
      - `number` string, required — Company street number
      - `cep` string, required — Company cep
    - `birth_date` string — Birthdate
    - `email` string — Email contact. Required if payment method is Redirection and Document is null.
    - `phone` Phone
      - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
      - `number` string, required — Phone number
      - `type` string — Phone type
    - `profile` Profile
      - `category` string — Customer level for example Free, Basic, Pro, Gold, etc
  - `device` DeviceData
    - `ipv4` string — The original ip address v4 from browser. Not required for Payment Antifraud Data with redirection payment. Required if ipv6 is blank
    - `ipv6` string — The original ip address v6 from browser. Not required for Payment Antifraud Data with redirection payment. Required if ipv4 is blank
    - `location` Location
      - `latitude` number, double, required — Device latitude
      - `longitude` number, double, required — Device longitude
    - `merchant_device` string — Id of the device, identified by the merchant by their internal systems
    - `session_id` string — Value generated by javascript/sdk snippet of our device fingerprint solution
  - `store` Store
    - `name` string, required — Store name, must not contain special characters and is limited to 20 characters, including spaces
    - `countryCode` string, required — Two-letter code as described in the ISO 3166 international standard
    - `documentType` 'CPF' | 'CNPJ', required — Type of the document
    - `document` string, required — Document number
    - `integration` 'api-standard' | 'bis2bis' | 'magento-1' | 'magento-2' | 'poolpay' | 'traycorp' | 'shopify' | 'vale-pay' | 'vtex' | 'woocommerce' | 'wbuy' — Integration source
  - `items` union[], required
    - union
      - Generic
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Generic', required — Item type
      - CarRental
        - `car_category` string
        - `car_description` string
        - `company_name` string
        - `drivers` Person[]
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `drop_off` DropOff
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `date` string, required — Delivery date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
        - `pick_up` PickUp
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `date` string, required — Delivery date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'CarRental', required — Item type
      - Lodging
        - `address` Address, required
          - `address` string, required — Company address
          - `number` string, required — Company street number
          - `cep` string, required — Company cep
        - `checkin_date` string, required — Checkin date. Date format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
        - `checkout_date` string, required — Checkout date. Date format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
        - `guests` Person[] — guests
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `lodger` Lodger
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `nights` integer, required — Number of nights
        - `refundable` boolean — is refundable
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Lodging', required — Item type
      - Flight
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `itinerary_type` 'MULTIDESTINATION' | 'ONEWAY' | 'ROUND_TRIP', required — Itinerary type
        - `passengers` Passenger[], required — Passengers list
          - `id` string — Person id
          - `first_name` string, required — First name
          - `last_name` string, required — Last name
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer, required — Item quantity
        - `route_type` 'DOMESTIC' | 'INTERNATIONAL' — Route type
        - `routes` Route[], required
          - `position` integer
          - `provider` string — Route provider
          - `segments` Segment[], required — Route segments list
            - `airline_code` string — Airline code
            - `departure` DepartureAirport
              - …
            - `arrival` ArrivalAirport
              - …
            - `flight_class` string — Flight class
            - `flight_number` integer — Flight number
            - `position` integer — Segment order
        - `seller_id` string — Item seller
      - Education
        - `course` Course
          - `category` string
          - `end_date` string — Course end date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `link` string — Course link
          - `monthly_fee` number — Course monthly fee
          - `name` string
          - `presential` boolean
          - `scholarship_percentage` integer — Course scholarship percentage
          - `start_date` string — Course start date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `subcategory` string
        - `students` Student[]
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string, required — Person birthdate
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `email` string, required — Person email contact
          - `first_name` string, required — Person first name
          - `gender` 'FEMALE' | 'MALE' | 'OTHER', required — Person gender
          - `id` string — Person id
          - `last_name` string, required — Person last name
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
          - `relationship_with_payer` string, required — Student relationship with payer
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Education', required — Item type
      - CellphoneInsurance
        - `client` Client
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `device` Device
          - `brand` string — Device brand
          - `imei` string — International Mobile Station Equipment Identity
          - `model` string — Device model
        - `insurance` Insurance
          - `expiration_date` string, date-time. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601 
          - `installment` number
          - `subscription_date` string, date-time. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601 
          - `type` string
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'CellphoneInsurance', required — Item type
      - CarPenaltyFee
        - `car` Car
          - `brand` string — Car brand
          - `identifier` CarIdentifier
            - `key` string — Car identifier key
            - `value` string — Car identifier value
          - `license_plate` string — license plate
          - `model` string — Car model
          - `owner` Owner
            - `id` string — Client custom person identifier
            - `first_name` string — First name. Required if full_name is blank.
            - `last_name` string — Last name. Required if full_name is blank.
            - `full_name` string — Full name. Is required if first_name and last_name are blank.
            - `document` Document — Document is required if payment method is Redirection and email is blank.
              - …
            - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
            - `address` Address
              - …
            - `birth_date` string — Birthdate
            - `email` string — Email contact.
            - `phone` Phone
              - …
          - `year` string — Car year
        - `fines` Fine[]
          - `car_owning_tax_type` 'IPVA' | 'SUCIVE'
          - `car_owning_tax_amount` CarOwningTaxAmount
            - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
            - `value` number, required — Amount value
          - `fine_issued_year` integer — Fine issued year
          - `insurance_amount` InsuranceAmount
            - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
            - `value` number, required — Amount value
          - `licesing_amount` LicesingAmount
            - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
            - `value` number, required — Amount value
          - `penalty_amount` PenaltyAmount
            - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
            - `value` number, required — Amount value
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'CarPenaltyFee', required — Item type
      - TravelInsurance
        - `provider` Provider, required
          - `code` string, required — Provider code
          - `name` string, required — Provider name
        - `modality` string — Travel insurance modality
        - `region` 'NATIONAL' | 'EUROPE' | 'UNITED_STATES' | 'LATIN_AMERICA' | 'MULTI_DESTINATION' | 'OTHER', required — Travel insurance region
        - `passengers` Person[], required — List of passengers
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `service` Service, required
          - `destination` string — Service destination
          - `end_date` string, required — Service end date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `id` string — Service id
          - `name` string — Service name
          - `number_of_passengers` integer, required — Number of passengers
          - `origin` string — Service origin
          - `start_date` string, required — Service start date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `sub_type` string — Service subType
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'TravelInsurance', required — Item type
      - Tour
        - `provider` Provider
          - `code` string, required — Provider code
          - `name` string, required — Provider name
        - `modality` string — Tour modality
        - `description` string — Description of the product
        - `passengers_resume` PassengersResume
          - `adults` integer, required — Adults count
          - `children` integer, required — Children count
          - `infants` integer, required — Infants count
        - `passengers` Person[], required — List of passengers
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `service` Service, required
          - `destination` string — Service destination
          - `end_date` string, required — Service end date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `id` string — Service id
          - `name` string — Service name
          - `number_of_passengers` integer, required — Number of passengers
          - `origin` string — Service origin
          - `start_date` string, required — Service start date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `sub_type` string — Service subType
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Tour', required — Item type
      - Ticket
        - `provider` Provider
          - `code` string, required — Provider code
          - `name` string, required — Provider name
        - `modality` string — Ticket modality
        - `delivery_method` string — How the ticket is delivered to the attendee. For example online, physical or box_office pickup.
        - `passengers` object[], required — List of passengers
          - `id` string — Client custom person identifier
          - `first_name` string, required — First name. Required if full_name is blank.
          - `last_name` string, required — Last name. Required if full_name is blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
        - `additional_information` object — Additional free-form information for the ticket. Can contain any key-value pairs.
        - `service` TicketService, required
          - `destination` string — Service destination
          - `end_date` string, required — Service end date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `id` string — Service id
          - `name` string — Service name
          - `number_of_passengers` integer, required — Number of passengers
          - `origin` string — Service origin
          - `start_date` string, required — Service start date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `sub_type` string — Service subType
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Ticket', required — Item type
      - TransferDS
        - `provider` Provider
          - `code` string, required — Provider code
          - `name` string, required — Provider name
        - `modality` string — Transfer modality
        - `description` string — Description of the product
        - `passengers_resume` PassengersResume
          - `adults` integer, required — Adults count
          - `children` integer, required — Children count
          - `infants` integer, required — Infants count
        - `passengers` Person[], required — List of passengers
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `service` Service, required
          - `destination` string — Service destination
          - `end_date` string, required — Service end date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `id` string — Service id
          - `name` string — Service name
          - `number_of_passengers` integer, required — Number of passengers
          - `origin` string — Service origin
          - `start_date` string, required — Service start date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `sub_type` string — Service subType
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Transfer', required — Item type
      - Financing
        - `recipient` Recipient
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Financing', required — Item type
  - `payments` union[], required
    - union
      - Cash
        - `details` string[], required — Cash networks
        - `id` string — Payment ID unique identifier
        - `method` 'Cash' | 'CreditCard' | 'DebitCard' | 'Pix' | 'Wallet' | 'GiftCard' | 'Points' | 'Promissory', required — Payment method used for the buyer
        - `payer` Payer
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `amount` PaymentAmount, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `paymentMethod` string[], required — Payment methods
        - `personData` PersonData, required
          - `firstName` string, required — Person first name
          - `lastName` string, required — Person last name
          - `email` string, required — Person email
          - `cpf` string, required — Person cpf
          - `birthDate` string, required — Birthdate
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `revenue` string, required — Person revenue
        - `companyData` CompanyData
          - `name` string, required — Company name
          - `cnpj` string, required — CNPJ
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `email` string, required — Company email
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `revenue` string, required — Person revenue
        - `transferData` TransferData, required
          - `period` 'D2' | 'D5' | 'D15' | 'D30' | 'FLOW', required — Advance payment period
          - `accountType` 'CACC' | 'SLARY' | 'SVGS' | 'TRAN', required — Account type
          - `account` string, required — Account number
          - `bank` string, required — Name of the person associated with the bank account
          - `code` string, required — Bank code
          - `branch` string, required — Bank branch
          - `documentNumber` string, required — Account document number
          - `documentType` 'CNPJ' | 'CPF', required — Document type
        - `pricing` PricingData[] — Pricing
          - `paymentMethod` 'CARD' | 'PIX', required — Payment method for the pricing configuration
          - `summarized` number, double — Pricing fee
          - `detailed` PricingDetail[] — Pricing detail table
            - `installment` integer, required — Installment
            - `brand` string, required — Card brand
            - `value` number, double, required — Pricing fee
      - CreditCard
        - `details` CardPaymentDetail, required
          - `bin` string — Abbreviation for 'Bank Indetification Number'. It's a code that identifies the institution responsable for issuing the credit card. Required for Payment and Wire Transfer
          - `brand_name` string — Brand card
          - `expiration_month` string — Card expiration month
          - `expiration_year` string — Card expiration year
          - `last_digits` string, required — Credit card identifier number last digits
          - `eci` string — Electronic Commerce Indicator. It's the code to notify about the authentication of the cardholder
          - `pos_entry_mode` 'MANUAL' | 'MAGNETIC_STRIPE' | 'BARCODE' | 'CHIP' — POS (point of sale) system method used to enter the card data
          - `pin_required` boolean — Indicates whether a PIN is required for the transaction
          - `signature` boolean — Indicates whether a signature was collected for the transaction
          - `icc_data` string — Integrated Circuit Card (ICC) data from the chip transaction
          - `icc_data_optional` string — Optional Integrated Circuit Card (ICC) data from the chip transaction
        - `id` string — Payment ID unique identifier
        - `method` 'Cash' | 'CreditCard' | 'DebitCard' | 'Pix' | 'Wallet' | 'GiftCard' | 'Points' | 'Promissory', required — Payment method used for the buyer
        - `payer` Payer
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `amount` PaymentAmount, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `subscription` boolean — it means it is a subscription or recurring payment
        - `concept` string — A brief description what we are paying
        - `paymentMethod` string[], required — Payment methods
        - `personData` PersonData, required
          - `firstName` string, required — Person first name
          - `lastName` string, required — Person last name
          - `email` string, required — Person email
          - `cpf` string, required — Person cpf
          - `birthDate` string, required — Birthdate
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `revenue` string, required — Person revenue
        - `companyData` CompanyData
          - `name` string, required — Company name
          - `cnpj` string, required — CNPJ
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `email` string, required — Company email
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `revenue` string, required — Person revenue
        - `transferData` TransferData, required
          - `period` 'D2' | 'D5' | 'D15' | 'D30' | 'FLOW', required — Advance payment period
          - `accountType` 'CACC' | 'SLARY' | 'SVGS' | 'TRAN', required — Account type
          - `account` string, required — Account number
          - `bank` string, required — Name of the person associated with the bank account
          - `code` string, required — Bank code
          - `branch` string, required — Bank branch
          - `documentNumber` string, required — Account document number
          - `documentType` 'CNPJ' | 'CPF', required — Document type
        - `pricing` PricingData[] — Pricing
          - `paymentMethod` 'CARD' | 'PIX', required — Payment method for the pricing configuration
          - `summarized` number, double — Pricing fee
          - `detailed` PricingDetail[] — Pricing detail table
            - `installment` integer, required — Installment
            - `brand` string, required — Card brand
            - `value` number, double, required — Pricing fee
      - GiftCard
        - `id` string — Payment ID unique identifier
        - `method` 'Cash' | 'CreditCard' | 'DebitCard' | 'Pix' | 'Wallet' | 'GiftCard' | 'Points' | 'Promissory', required — Payment method used for the buyer
        - `amount` PaymentAmount, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `paymentMethod` string[], required — Payment methods
        - `personData` PersonData, required
          - `firstName` string, required — Person first name
          - `lastName` string, required — Person last name
          - `email` string, required — Person email
          - `cpf` string, required — Person cpf
          - `birthDate` string, required — Birthdate
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `revenue` string, required — Person revenue
        - `companyData` CompanyData
          - `name` string, required — Company name
          - `cnpj` string, required — CNPJ
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `email` string, required — Company email
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `revenue` string, required — Person revenue
        - `transferData` TransferData, required
          - `period` 'D2' | 'D5' | 'D15' | 'D30' | 'FLOW', required — Advance payment period
          - `accountType` 'CACC' | 'SLARY' | 'SVGS' | 'TRAN', required — Account type
          - `account` string, required — Account number
          - `bank` string, required — Name of the person associated with the bank account
          - `code` string, required — Bank code
          - `branch` string, required — Bank branch
          - `documentNumber` string, required — Account document number
          - `documentType` 'CNPJ' | 'CPF', required — Document type
        - `pricing` PricingData[] — Pricing
          - `paymentMethod` 'CARD' | 'PIX', required — Payment method for the pricing configuration
          - `summarized` number, double — Pricing fee
          - `detailed` PricingDetail[] — Pricing detail table
            - `installment` integer, required — Installment
            - `brand` string, required — Card brand
            - `value` number, double, required — Pricing fee
      - DebitCard
        - `details` CardPaymentDetail, required
          - `bin` string — Abbreviation for 'Bank Indetification Number'. It's a code that identifies the institution responsable for issuing the credit card. Required for Payment and Wire Transfer
          - `brand_name` string — Brand card
          - `expiration_month` string — Card expiration month
          - `expiration_year` string — Card expiration year
          - `last_digits` string, required — Credit card identifier number last digits
          - `eci` string — Electronic Commerce Indicator. It's the code to notify about the authentication of the cardholder
          - `pos_entry_mode` 'MANUAL' | 'MAGNETIC_STRIPE' | 'BARCODE' | 'CHIP' — POS (point of sale) system method used to enter the card data
          - `pin_required` boolean — Indicates whether a PIN is required for the transaction
          - `signature` boolean — Indicates whether a signature was collected for the transaction
          - `icc_data` string — Integrated Circuit Card (ICC) data from the chip transaction
          - `icc_data_optional` string — Optional Integrated Circuit Card (ICC) data from the chip transaction
        - `id` string — Payment ID unique identifier
        - `method` 'Cash' | 'CreditCard' | 'DebitCard' | 'Pix' | 'Wallet' | 'GiftCard' | 'Points' | 'Promissory', required — Payment method used for the buyer
        - `payer` Payer
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `amount` PaymentAmount, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `subscription` boolean — it means it is a subscription or recurring payment
        - `concept` string — A brief description what we are paying
        - `paymentMethod` string[], required — Payment methods
        - `personData` PersonData, required
          - `firstName` string, required — Person first name
          - `lastName` string, required — Person last name
          - `email` string, required — Person email
          - `cpf` string, required — Person cpf
          - `birthDate` string, required — Birthdate
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `revenue` string, required — Person revenue
        - `companyData` CompanyData
          - `name` string, required — Company name
          - `cnpj` string, required — CNPJ
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `email` string, required — Company email
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `revenue` string, required — Person revenue
        - `transferData` TransferData, required
          - `period` 'D2' | 'D5' | 'D15' | 'D30' | 'FLOW', required — Advance payment period
          - `accountType` 'CACC' | 'SLARY' | 'SVGS' | 'TRAN', required — Account type
          - `account` string, required — Account number
          - `bank` string, required — Name of the person associated with the bank account
          - `code` string, required — Bank code
          - `branch` string, required — Bank branch
          - `documentNumber` string, required — Account document number
          - `documentType` 'CNPJ' | 'CPF', required — Document type
        - `pricing` PricingData[] — Pricing
          - `paymentMethod` 'CARD' | 'PIX', required — Payment method for the pricing configuration
          - `summarized` number, double — Pricing fee
          - `detailed` PricingDetail[] — Pricing detail table
            - `installment` integer, required — Installment
            - `brand` string, required — Card brand
            - `value` number, double, required — Pricing fee
      - PrePaidCard
        - `details` CardPaymentDetail, required
          - `bin` string — Abbreviation for 'Bank Indetification Number'. It's a code that identifies the institution responsable for issuing the credit card. Required for Payment and Wire Transfer
          - `brand_name` string — Brand card
          - `expiration_month` string — Card expiration month
          - `expiration_year` string — Card expiration year
          - `last_digits` string, required — Credit card identifier number last digits
          - `eci` string — Electronic Commerce Indicator. It's the code to notify about the authentication of the cardholder
          - `pos_entry_mode` 'MANUAL' | 'MAGNETIC_STRIPE' | 'BARCODE' | 'CHIP' — POS (point of sale) system method used to enter the card data
          - `pin_required` boolean — Indicates whether a PIN is required for the transaction
          - `signature` boolean — Indicates whether a signature was collected for the transaction
          - `icc_data` string — Integrated Circuit Card (ICC) data from the chip transaction
          - `icc_data_optional` string — Optional Integrated Circuit Card (ICC) data from the chip transaction
        - `id` string — Payment ID unique identifier
        - `method` 'Cash' | 'CreditCard' | 'DebitCard' | 'Pix' | 'Wallet' | 'GiftCard' | 'Points' | 'Promissory', required — Payment method used for the buyer
        - `payer` Payer
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `amount` PaymentAmount, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `subscription` boolean — it means it is a subscription or recurring payment
        - `concept` string — A brief description what we are paying
        - `paymentMethod` string[], required — Payment methods
        - `personData` PersonData, required
          - `firstName` string, required — Person first name
          - `lastName` string, required — Person last name
          - `email` string, required — Person email
          - `cpf` string, required — Person cpf
          - `birthDate` string, required — Birthdate
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `revenue` string, required — Person revenue
        - `companyData` CompanyData
          - `name` string, required — Company name
          - `cnpj` string, required — CNPJ
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `email` string, required — Company email
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `revenue` string, required — Person revenue
        - `transferData` TransferData, required
          - `period` 'D2' | 'D5' | 'D15' | 'D30' | 'FLOW', required — Advance payment period
          - `accountType` 'CACC' | 'SLARY' | 'SVGS' | 'TRAN', required — Account type
          - `account` string, required — Account number
          - `bank` string, required — Name of the person associated with the bank account
          - `code` string, required — Bank code
          - `branch` string, required — Bank branch
          - `documentNumber` string, required — Account document number
          - `documentType` 'CNPJ' | 'CPF', required — Document type
        - `pricing` PricingData[] — Pricing
          - `paymentMethod` 'CARD' | 'PIX', required — Payment method for the pricing configuration
          - `summarized` number, double — Pricing fee
          - `detailed` PricingDetail[] — Pricing detail table
            - `installment` integer, required — Installment
            - `brand` string, required — Card brand
            - `value` number, double, required — Pricing fee
      - PIX
        - `method` 'Pix', required — Payment method used for the buyer
        - `payer` Payer
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `amount` PaymentAmount, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `expiration_date` string, date-time, required — Pix payment expiration date
        - `payment_key` string — Pix payment key
      - Wallet
        - `method` 'Wallet', required — Payment method used for the buyer
        - `payer` Payer
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `amount` PaymentAmount, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `provider` 'APPLE_PAY' | 'GOOGLE_PAY' | 'NUPAY' | 'IFOOD_PAY', required — Wallet provider
      - Points
        - `paymentMethod` string[], required — Payment methods
        - `personData` PersonData, required
          - `firstName` string, required — Person first name
          - `lastName` string, required — Person last name
          - `email` string, required — Person email
          - `cpf` string, required — Person cpf
          - `birthDate` string, required — Birthdate
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `revenue` string, required — Person revenue
        - `companyData` CompanyData
          - `name` string, required — Company name
          - `cnpj` string, required — CNPJ
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `email` string, required — Company email
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `revenue` string, required — Person revenue
        - `transferData` TransferData, required
          - `period` 'D2' | 'D5' | 'D15' | 'D30' | 'FLOW', required — Advance payment period
          - `accountType` 'CACC' | 'SLARY' | 'SVGS' | 'TRAN', required — Account type
          - `account` string, required — Account number
          - `bank` string, required — Name of the person associated with the bank account
          - `code` string, required — Bank code
          - `branch` string, required — Bank branch
          - `documentNumber` string, required — Account document number
          - `documentType` 'CNPJ' | 'CPF', required — Document type
        - `pricing` PricingData[] — Pricing
          - `paymentMethod` 'CARD' | 'PIX', required — Payment method for the pricing configuration
          - `summarized` number, double — Pricing fee
          - `detailed` PricingDetail[] — Pricing detail table
            - `installment` integer, required — Installment
            - `brand` string, required — Card brand
            - `value` number, double, required — Pricing fee
      - Promissory
        - `installments` integer, required — Number of installments
        - `provider` string, required — Promissory provider name
        - `id` string — Payment ID unique identifier
        - `method` 'Cash' | 'CreditCard' | 'DebitCard' | 'Pix' | 'Wallet' | 'GiftCard' | 'Points' | 'Promissory', required — Payment method used for the buyer
        - `payer` Payer
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `amount` number, required — Payment amount. Two decimal places
        - `paymentMethod` string[], required — Payment methods
        - `personData` PersonData, required
          - `firstName` string, required — Person first name
          - `lastName` string, required — Person last name
          - `email` string, required — Person email
          - `cpf` string, required — Person cpf
          - `birthDate` string, required — Birthdate
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `revenue` string, required — Person revenue
        - `companyData` CompanyData
          - `name` string, required — Company name
          - `cnpj` string, required — CNPJ
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `email` string, required — Company email
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `revenue` string, required — Person revenue
        - `transferData` TransferData, required
          - `period` 'D2' | 'D5' | 'D15' | 'D30' | 'FLOW', required — Advance payment period
          - `accountType` 'CACC' | 'SLARY' | 'SVGS' | 'TRAN', required — Account type
          - `account` string, required — Account number
          - `bank` string, required — Name of the person associated with the bank account
          - `code` string, required — Bank code
          - `branch` string, required — Bank branch
          - `documentNumber` string, required — Account document number
          - `documentType` 'CNPJ' | 'CPF', required — Document type
        - `pricing` PricingData[] — Pricing
          - `paymentMethod` 'CARD' | 'PIX', required — Payment method for the pricing configuration
          - `summarized` number, double — Pricing fee
          - `detailed` PricingDetail[] — Pricing detail table
            - `installment` integer, required — Installment
            - `brand` string, required — Card brand
            - `value` number, double, required — Pricing fee
      - Transfer
        - `paymentMethod` string[], required — Payment methods
        - `personData` PersonData, required
          - `firstName` string, required — Person first name
          - `lastName` string, required — Person last name
          - `email` string, required — Person email
          - `cpf` string, required — Person cpf
          - `birthDate` string, required — Birthdate
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `revenue` string, required — Person revenue
        - `companyData` CompanyData
          - `name` string, required — Company name
          - `cnpj` string, required — CNPJ
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `email` string, required — Company email
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `revenue` string, required — Person revenue
        - `transferData` TransferData, required
          - `period` 'D2' | 'D5' | 'D15' | 'D30' | 'FLOW', required — Advance payment period
          - `accountType` 'CACC' | 'SLARY' | 'SVGS' | 'TRAN', required — Account type
          - `account` string, required — Account number
          - `bank` string, required — Name of the person associated with the bank account
          - `code` string, required — Bank code
          - `branch` string, required — Bank branch
          - `documentNumber` string, required — Account document number
          - `documentType` 'CNPJ' | 'CPF', required — Document type
        - `pricing` PricingData[] — Pricing
          - `paymentMethod` 'CARD' | 'PIX', required — Payment method for the pricing configuration
          - `summarized` number, double — Pricing fee
          - `detailed` PricingDetail[] — Pricing detail table
            - `installment` integer, required — Installment
            - `brand` string, required — Card brand
            - `value` number, double, required — Pricing fee
      - Asynchronous
        - `paymentMethod` string[], required — Payment methods
        - `personData` PersonData, required
          - `firstName` string, required — Person first name
          - `lastName` string, required — Person last name
          - `email` string, required — Person email
          - `cpf` string, required — Person cpf
          - `birthDate` string, required — Birthdate
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `revenue` string, required — Person revenue
        - `companyData` CompanyData
          - `name` string, required — Company name
          - `cnpj` string, required — CNPJ
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `email` string, required — Company email
          - `countryCode` string, required — Phone country code
          - `phone` string, required — Phone number
          - `mcc` string, required — Merchant Category Codes. Four-digit number
          - `revenue` string, required — Person revenue
        - `transferData` TransferData, required
          - `period` 'D2' | 'D5' | 'D15' | 'D30' | 'FLOW', required — Advance payment period
          - `accountType` 'CACC' | 'SLARY' | 'SVGS' | 'TRAN', required — Account type
          - `account` string, required — Account number
          - `bank` string, required — Name of the person associated with the bank account
          - `code` string, required — Bank code
          - `branch` string, required — Bank branch
          - `documentNumber` string, required — Account document number
          - `documentType` 'CNPJ' | 'CPF', required — Document type
        - `pricing` PricingData[] — Pricing
          - `paymentMethod` 'CARD' | 'PIX', required — Payment method for the pricing configuration
          - `summarized` number, double — Pricing fee
          - `detailed` PricingDetail[] — Pricing detail table
            - `installment` integer, required — Installment
            - `brand` string, required — Card brand
            - `value` number, double, required — Pricing fee
  - `shipping` Shipping
    - `address` Address, required
      - `address` string, required — Company address
      - `number` string, required — Company street number
      - `cep` string, required — Company cep
    - `delivery` Delivery
      - `by` string — Shipping delivery company
      - `date` string — Shipping delivery date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
      - `type` 'EXPRESS' | 'NORMAL' — Shipping delivery type
    - `price` Price, required
      - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
      - `value` number, required — Amount value
  - `transaction` TransactionData, required
    - `reference_id` string, required — Client transaction identifier
    - `business_id` string — Unique identifier for the store where the transaction takes place.
    - `sequence` string — Sequence number
    - `country_code` string, required — Use the country code of the store site's location where the transaction takes place. This ensures alignment with the store's geographical context. Two-letter code as described in the ISO 3166 international standard
    - `total_amount` Amount, required
      - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
      - `value` number, required — Amount value
    - `channel` string — Indicates sales channel
  - `service_date` string — Date which the service will take place
  - `sla_date` string — The date that the evaluation is expected to be resolved
  - `callback_url` string — A publicly accessible HTTPS endpoint where your application will receive asynchronous notifications about the status of the evaluation.
  - `client_info` ClientInfo
    - `creation_date` string, date-time — Client creation date
    - `classification` string — Client classification level
    - `customer_order` Amount
      - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
      - `value` number, required — Amount value
    - `days_since_first_order` integer — Days since first order
    - `days_since_last_order` integer — Days since last order
    - `cancelled_orders` integer — Number of cancelled orders
    - `average_order` Amount
      - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
      - `value` number, required — Amount value
    - `cash_orders` integer — Number of cash paid orders
    - `card_orders` integer — Number of card paid orders
    - `bank_orders` integer — Number of bank check paid orders
    - `debit_orders` integer — Number of debit paid orders
    - `super_segmentation` string — Super segmentation category
    - `purchase_power` string — Purchase power classification
    - `year_first_purchase` integer — Year of first purchase
    - `purchases_30_days` integer — Number of purchases in last 30 days
    - `purchases_60_days` integer — Number of purchases in last 60 days
    - `purchases_lifetime` integer — Total lifetime purchases
  - `strategies_data` StrategiesData — Optional data for fraud prevention strategies
    - `collect_auth_supported` boolean — Indicates if collect authentication is supported
    - `acquirer_bin` string — Acquirer Bank Identification Number
    - `acquirer` string — Acquirer identifier
    - `merchant_id` string — Merchant identifier
    - `mcc` string — Merchant Category Code
    - `merchant_descriptor` string — Merchant descriptor

## Response `200`

Evaluation response

- StandardApiPreEvalResponse
  - `analysis_type` 'AUTOMATIC' | 'MANUAL' — Resolution type
  - `evaluation_id` string — antifraud provider identifier
  - `id` string — Client transaction identifier
  - `score` integer — Evaluation score
  - `status` 'approved' | 'denied' — Transaction status

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.dev/koin/apis/payments-api.md) · [All operations](https://skmtc.dev/koin/apis/payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/koin/payments-api/revisions/6f2c01e43fe2/schema)