--- title: "Create Payment" method: POST path: "/v1/payment/orders" tags: ["Payment Services"] --- # Create Payment `POST /v1/payment/orders` Create payment service. Required fields are validated first, then business rules are applied. ## Headers - `Content-Type` string, required - `Accept` string, required ## Request body - union - union - PaymentPIXApi - `store` object - `code` string — Store identifier - `category` string — Four-digit ISO 18245 merchant category code - `transaction` object, required - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction). - `business_id` string — Business ID. The ID of the transaction related with this payment - `account` string, required — Client account number provided by Koin - `amount` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Payment total amount - `breakdown` object - `items` object, required - … - `shipping` object, required - … - `taxes` object, required - … - `fee` object - … - `country_code` string, required — Transaction country code (two-letter ISO 3166 country code) - `channel` 'API' | 'CHECKOUT' | 'LINK' | 'SDK' — Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration. - `payment_method` object, required - `code` 'PIX' | 'CARD' | 'BNPL', required — Payment method code - `expiration_date` string, date-time, required — Payment expiration date (In ISO 8601 format with UTC in GMT 0) - `payment_key` string — Represents the pix key. Exclusive for the PIX payment method. If you do not send a pix key, a previously configured default will be used. (Maximum of 100 characters) - `payer` object - `document` object, required — Payer identification document - `type` 'cpf' | 'cnpj', required — Payer document type - `number` string, required — Payer document number - `nationality` string — Payer nationality (two-letter ISO 3166 country code) - `first_name` string — Payer first name. If the length of the field exceeds 100 characters it will be truncated - `last_name` string — Payer last name. If the length of the field exceeds 100 characters it will be truncated - `full_name` string — Payer full name. If the length of the field exceeds 100 characters it will be truncated - `email` string — Payer email - `phone` object - `country_code` string — Country code - `area` string, required — Area code - `number` string, required — Phone number - `type` string — Phone type (e.g., Mobile) - `descriptor` string — Description sent to recipient of payment (Max. 140 characters) - `notification_url` string[] — Optional list of URLs to which payment status notifications will be sent - `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 - PaymentPIXCheckout - `store` object - `code` string — Store identifier - `category` string — Four-digit ISO 18245 merchant category code - `transaction` object, required - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction). - `business_id` string — Business ID. The ID of the transaction related with this payment - `account` string, required — Client account number provided by Koin - `amount` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Payment total amount - `breakdown` object - `items` object, required - … - `shipping` object, required - … - `taxes` object, required - … - `fee` object - … - `country_code` string, required — Transaction country code (two-letter ISO 3166 country code) - `channel` 'API' | 'CHECKOUT' | 'LINK' | 'SDK' — Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration. - `payment_method` object, required - `code` 'PIX' | 'CARD' | 'BNPL', required — Payment method code - `expiration_date` string, date-time, required — Payment expiration date (In ISO 8601 format with UTC in GMT 0) - `payment_key` string — Represents the pix key. Exclusive for the PIX payment method. If you do not send a pix key, a previously configured default will be used. (Maximum of 100 characters) - `payer` object - `document` object, required — Payer identification document - `type` 'cpf' | 'cnpj', required — Payer document type - `number` string, required — Payer document number - `nationality` string — Payer nationality (two-letter ISO 3166 country code) - `first_name` string — Payer first name. If the length of the field exceeds 100 characters it will be truncated - `last_name` string — Payer last name. If the length of the field exceeds 100 characters it will be truncated - `full_name` string — Payer full name. If the length of the field exceeds 100 characters it will be truncated - `email` string — Payer email - `phone` object - `country_code` string — Country code - `area` string, required — Area code - `number` string, required — Phone number - `type` string — Phone type (e.g., Mobile) - `descriptor` string — Description sent to recipient of payment (Max. 140 characters) - `notification_url` string[] — Optional list of URLs to which payment status notifications will be sent - `redirect_url` object - `success_url` string, required — Redirect URL for successful payment - `cancel_url` string, required — Redirect URL for cancelled payment - `failed_url` string, required — Redirect URL for failed payment - `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 - PaymentBNPL - `store` object - `code` string — Store identifier - `category` string — Four-digit ISO 18245 merchant category code - `transaction` object, required - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction). - `business_id` string — Business ID. The ID of the transaction related with this payment - `account` string, required — Client account number provided by Koin - `amount` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Payment total amount - `breakdown` object, required - `items` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Items total amount - `shipping` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Shipping total amount - `taxes` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Taxes total amount - `country_code` string, required — Transaction country code (two-letter ISO 3166 country code) - `channel` 'API' | 'CHECKOUT' | 'LINK' | 'SDK' — Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration. - `payment_method` object, required - `code` 'PIX' | 'CARD' | 'BNPL', required — Payment method code - `expiration_date` string, date-time, required — Payment expiration date (In ISO 8601 format with UTC in GMT 0) - `option_id` string — Availability installment option identifier (required for transparent checkout). - `payer` object, required - `document` object, required — Payer identification document - `type` 'cpf', required — Payer document type - `number` string, required — Payer document number - `nationality` string — Payer nationality (two-letter ISO 3166 country code) - `first_name` string — Payer first name. If the length of the field exceeds 100 characters it will be truncated - `last_name` string — Payer last name. If the length of the field exceeds 100 characters it will be truncated - `name_father` string — Payer's paternal last name. If the length of the field exceeds 100 characters it will be truncated (Only for BNPL payment method) - `name_mother` string — Payer's maternal last name. If the length of the field exceeds 100 characters it will be truncated (Only for BNPL payment method) - `full_name` string — Payer full name. If the length of the field exceeds 100 characters it will be truncated - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Payer gender - `email` string, required — Payer email - `phone` object, required - `country_code` string — Country code - `area` string, required — Area code - `number` string, required — Phone number - `type` string — Phone type (e.g., Mobile) - `birthdate` string — Payer birthdate - `address` object, required - `country_code` string, required — Country code (two-letter ISO 3166 country code) - `state` string, required — State code - `city_name` string, required — City name - `street` string, required — Street name - `number` string, required — Building number - `zip_code` string, required — ZIP code - `district` string — District - `complement` string — Additional address information - `shipping` object, required - `delivery_date` string, required — Shipping delivery date - `address` object, required - `country_code` string, required — Country code (two-letter ISO 3166 country code) - `state` string, required — State code - `city_name` string, required — City name - `street` string, required — Street name - `number` string, required — Building number - `zip_code` string, required — ZIP code - `district` string — District - `complement` string — Additional address information - `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 - GenericLegacy - `reference` string, required — Item identifier - `name` string, required — Item name - `price` object, required — Item price - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Amount - `quantity` integer, required — Item quantity - `discount` number, required — Item discount - `category` string, required — Category name - 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. - … - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender - `address` Address - … - `birth_date` string — Birthdate - `email` string — Email contact. - `phone` Phone - … - `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 - 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. - … - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender - `address` Address - … - `birth_date` string — Birthdate - `email` string — Email contact. - `phone` Phone - … - `drop_off` DropOff - `address` Address, required - … - `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 - … - `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. - … - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender - `address` Address - … - `birth_date` string — Birthdate - `email` string — Email contact. - `phone` Phone - … - `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. - … - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender - `address` Address - … - `birth_date` string — Birthdate - `email` string — Email contact. - `phone` Phone - … - `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. - … - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender - `address` Address - … - `birth_date` string — Birthdate - `email` string — Email contact - `phone` Phone - … - `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 - … - `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 - … - `birth_date` string, required — Person birthdate - `document` Document — Document is required if payment method is Redirection and email is blank. - … - `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 - … - `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. - … - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender - `address` Address - … - `birth_date` string — Birthdate - `email` string — Email contact. - `phone` Phone - … - `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 - … - `license_plate` string — license plate - `model` string — Car model - `owner` Owner - … - `year` string — Car year - `fines` Fine[] - `car_owning_tax_type` 'IPVA' | 'SUCIVE' - `car_owning_tax_amount` CarOwningTaxAmount - … - `fine_issued_year` integer — Fine issued year - `insurance_amount` InsuranceAmount - … - `licesing_amount` LicesingAmount - … - `penalty_amount` PenaltyAmount - … - `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. - … - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender - `address` Address - … - `birth_date` string — Birthdate - `email` string — Email contact. - `phone` Phone - … - `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. - … - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender - `address` Address - … - `birth_date` string — Birthdate - `email` string — Email contact. - `phone` Phone - … - `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 - 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. - … - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender - `address` Address - … - `birth_date` string — Birthdate - `email` string — Email contact. - `phone` Phone - … - `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 - Bus - `id` string, required — Item id - `itinerary_type` 'MULTIDESTINATION' | 'ONEWAY' | 'ROUND_TRIP', required — Itinerary type - `passengers` PassengerBus[], required — Passengers list - `id` string — Person id - `first_name` string, required — First name - `last_name` string, required — Last name - `document` Document, required — 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` PhoneBus - … - `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` RouteBus[], required - `position` integer, required - `company_name` string, required — Company name - `departure` DepartureBus, required - … - `arrival` ArrivalBus, required - … - `type` 'Bus', required — Item type - `verified_id` boolean, required — Indicates if the buyer's ID was verified - `descriptor` string — Description sent to recipient of payment (Max. 140 characters) - `device_fingerprint` string, required — Deprecated: use device.session_id instead. Represents the device used to initiate the payment. Still accepted as a fallback during the transition period - `ip_address` string, required — Deprecated: use device.ipv4 or device.ipv6 instead. Buyer ip address. Still accepted as a fallback during the transition period - `notification_url` string[] — Optional list of URLs to which payment status notifications will be sent - `payment_url` string — Url checkout for payment - `terms` object - `accepted` boolean — Indicates whether the customer accepted the terms and conditions (required for transparent checkout) - `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 - union - PaymentCard - `store` object - `code` string — Store identifier - `transaction` object, required - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction). - `business_id` string — Business ID. The ID of the transaction related with this payment - `account` string, required — Client account number provided by Koin - `amount` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Payment total amount - `breakdown` object - `items` object, required - … - `shipping` object - … - `fee` object - … - `country_code` string, required — Transaction country code (two-letter ISO 3166 country code) - `channel` 'API' | 'CHECKOUT' | 'LINK' | 'SDK' — Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration. - `payment_method` union, required - PaymentCardMethod - `code` 'CARD', required — Payment method code - `secure_token` string, required — Secure token - `installments` number, required — Installments of the payment - PaymentCardGooglePayMethod - `code` 'GOOGLEPAY', required — Payment method code - `secure_payload` string, required — Google Pay payload - `installments` number, required — Installments of the payment - `payer` object, required - `document` object — Payer identification document (only required for country_code AR) - `type` 'cpf' | 'cnpj', required — Payer document type - `number` string, required — Payer document number - `phone` object - `area` string, required — Area code - `number` string, required — Phone number - `descriptor` string — Description sent to recipient of payment (Max. 140 characters) - `notification_url` string[] — Optional list of URLs to which payment status notifications will be sent - `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 - PaymentCardWithAntiFraud - `store` object - `code` string — Store identifier - `category` string — Four-digit ISO 18245 merchant category code - `transaction` object, required - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction). - `business_id` string — Business ID. The ID of the transaction related with this payment - `account` string, required — Client account number provided by Koin - `amount` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Payment total amount - `breakdown` object - `items` object, required - … - `shipping` object - … - `fee` object - … - `country_code` string, required — Transaction country code (two-letter ISO 3166 country code) - `channel` 'API' | 'CHECKOUT' | 'LINK' | 'SDK' — Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration. - `payment_method` union, required - PaymentCardMethod - `code` 'CARD', required — Payment method code - `secure_token` string, required — Secure token - `installments` number, required — Installments of the payment - PaymentCardGooglePayMethod - `code` 'GOOGLEPAY', required — Payment method code - `secure_payload` string, required — Google Pay payload - `installments` number, required — Installments of the payment - `payer` object - `first_name` string — Payer first name. Required if full_name is blank. - `last_name` string — Payer last name. Required if full_name is blank. - `full_name` string — Payer full name. Required if first_name and last_name are blank. - `document` object — Payer identification document - `type` string, required — Payer document type - `number` string, required — Payer document number - `nationality` string — Payer nationality (two-letter ISO 3166 country code) - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Payer gender - `address` Address - `address` string, required — Company address - `number` string, required — Company street number - `cep` string, required — Company cep - `birthdate` string — Payer birthdate - `email` string — Payer email. Required for Ecommerce Antifraud integration. - `phone` object - `country_code` string — Country code - `area` string, required — Area code - `number` string, required — Phone number - `type` string — Phone type (e.g., Mobile) - `buyer` Buyer - `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 - `items` union[] — Required for Ecommerce Antifraud integration. - union - Generic - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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[] - … - `drop_off` DropOff - … - `pick_up` PickUp - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `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 - … - `lodger` Lodger - … - `nights` integer, required — Number of nights - `refundable` boolean — is refundable - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `id` string, required — Item id - `itinerary_type` 'MULTIDESTINATION' | 'ONEWAY' | 'ROUND_TRIP', required — Itinerary type - `passengers` Passenger[], required — Passengers list - … - `price` Price, required - … - `quantity` integer, required — Item quantity - `route_type` 'DOMESTIC' | 'INTERNATIONAL' — Route type - `routes` Route[], required - … - `seller_id` string — Item seller - Education - `course` Course - … - `students` Student[] - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `device` Device - … - `insurance` Insurance - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `fines` Fine[] - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `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 - … - `service` Service, required - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `modality` string — Tour modality - `description` string — Description of the product - `passengers_resume` PassengersResume - … - `passengers` Person[], required — List of passengers - … - `service` Service, required - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - TransferDS - `provider` Provider - … - `modality` string — Transfer modality - `description` string — Description of the product - `passengers_resume` PassengersResume - … - `passengers` Person[], required — List of passengers - … - `service` Service, required - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - Subscription - `id` string, required — Item id - `name` string, required — Item name - `price` Price, required - … - `category` object, required - … - `subscription_date` string, required — Date which the service will take place (In ISO 8601 format with UTC in GMT 0) - `end_date` string — Date which the service will take place (In ISO 8601 format with UTC in GMT 0) - `concept` 'NEW_SUBSCRIPTION' | 'CARD_CHANGE' | 'RECURRING', required — Concept - `frequency` object, required - … - `type` 'Subscription', required — Item type - `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 - `descriptor` string — Description sent to recipient of payment (Max. 140 characters) - `notification_url` string[] — Optional list of URLs to which payment status notifications will be sent - `redirect_url` object - `antifraud_url` string — Redirect URL for antifraud response - `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 - PaymentCardWithCheckout - `store` object - `code` string — Store identifier - `category` string — Four-digit ISO 18245 merchant category code - `transaction` object, required - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction). - `business_id` string — Business ID. The ID of the transaction related with this payment - `account` string, required — Client account number provided by Koin - `amount` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Payment total amount - `breakdown` object - `items` object - … - `taxes` object - … - `shipping` object - … - `fee` object - … - `country_code` string, required — Transaction country code (two-letter ISO 3166 country code) - `channel` 'API' | 'CHECKOUT' | 'LINK' | 'SDK' — Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration. - `payment_method` object, required - `code` 'CARD', required — Payment method code - `expiration_date` string, date-time — Link checkout expiration date (In ISO 8601 format with UTC in GMT 0) - `payer` object, required - `first_name` string — Payer first name. Required if full_name is blank. - `last_name` string — Payer last name. Required if full_name is blank. - `full_name` string — Payer full name. Required if first_name and last_name are blank. - `document` object — Payer identification document - `type` string, required — Payer document type - `number` string, required — Payer document number - `nationality` string — Payer nationality (two-letter ISO 3166 country code) - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Payer gender - `address` Address - `address` string, required — Company address - `number` string, required — Company street number - `cep` string, required — Company cep - `birthdate` string — Payer birthdate - `email` string, required — Payer email. Required for Ecommerce Antifraud integration. - `phone` object - `country_code` string — Country code - `area` string, required — Area code - `number` string, required — Phone number - `type` string — Phone type (e.g., Mobile) - `buyer` Buyer - `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 - `items` union[] — Required for Ecommerce Antifraud integration. - union - Generic - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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[] - … - `drop_off` DropOff - … - `pick_up` PickUp - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `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 - … - `lodger` Lodger - … - `nights` integer, required — Number of nights - `refundable` boolean — is refundable - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `id` string, required — Item id - `itinerary_type` 'MULTIDESTINATION' | 'ONEWAY' | 'ROUND_TRIP', required — Itinerary type - `passengers` Passenger[], required — Passengers list - … - `price` Price, required - … - `quantity` integer, required — Item quantity - `route_type` 'DOMESTIC' | 'INTERNATIONAL' — Route type - `routes` Route[], required - … - `seller_id` string — Item seller - Education - `course` Course - … - `students` Student[] - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `device` Device - … - `insurance` Insurance - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `fines` Fine[] - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `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 - … - `service` Service, required - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `modality` string — Tour modality - `description` string — Description of the product - `passengers_resume` PassengersResume - … - `passengers` Person[], required — List of passengers - … - `service` Service, required - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - TransferDS - `provider` Provider - … - `modality` string — Transfer modality - `description` string — Description of the product - `passengers_resume` PassengersResume - … - `passengers` Person[], required — List of passengers - … - `service` Service, required - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - … - `category` Category, required - … - `discount_amount` DiscountAmount - … - `id` string, required — Item id - `name` string, required — item name - `price` Price, required - … - `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 - `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 - `descriptor` string — Description sent to recipient of payment (Max. 140 characters) - `notification_url` string[] — Optional list of URLs to which payment status notifications will be sent - `redirect_url` object - `success_url` string, required — Redirect URL for successful payment - `cancel_url` string, required — Redirect URL for cancelled payment - `failed_url` string, required — Redirect URL for failed payment - `mobile` boolean — Indicates if the device is mobile - `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 - PaymentMODO — MODO wallet payment method, available in Argentina (country_code AR, currency ARS). - `store` object - `code` string — Store identifier - `category` string — Four-digit ISO 18245 merchant category code - `transaction` object, required - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction). - `business_id` string — Business ID. The ID of the transaction related with this payment - `account` string, required — Client account number provided by Koin - `amount` object, required - `currency_code` 'ARS', required — Currency code (ISO 4217) - `value` number, required — Payment total amount - `country_code` 'AR', required — Transaction country code (two-letter ISO 3166 country code) - `payment_method` object, required - `code` 'MODO', required — Payment method code - `expiration_date` string, date-time — Payment intention expiration date (In ISO 8601 format with UTC in GMT 0). Optional; if sent, it must be a future date - `payer` object - `document` object — Payer identification document - `type` string — Payer document type - `number` string — Payer document number - `first_name` string — Payer first name. If the length of the field exceeds 100 characters it will be truncated - `last_name` string — Payer last name. If the length of the field exceeds 100 characters it will be truncated - `full_name` string — Payer full name. If the length of the field exceeds 100 characters it will be truncated - `email` string — Payer email - `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 - `descriptor` string — Description sent to recipient of payment (Max. 140 characters) - `notification_url` string[] — List of URLs to which notifications will be sent. Strongly recommended for MODO, since status changes (Published, Collected) are reported asynchronously ## Response `200` Create payment response - union - PixPaymentResponse - `store` object - `code` string — Store identifier. - `category` string — Four-digit ISO 18245 merchant category code. - `transaction` object, required - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction). - `business_id` string — Business ID. The ID of the transaction related with this payment. - `account` integer — Client account number. - `amount` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Total amount - `provider_reference` object — Provider reference data - `tx_id` string, required — Provider order identifier, used to identify the order in the bank - `order_id` string, required — Order ID returned by create payment service - `status` object, required - `type` 'Opened' | 'Published' | 'Collected' | 'Failed', required — Payment status. - `date` string, date-time, required — Status change date (ISO 8601 date format) - `error` StatusError — Error details. Present when the payment failed and error information is available. - `code` string — Error code. - `message` string — Error message. - `country_code` string, required — Transaction country code. - `channel` 'API' | 'CHECKOUT' | 'LINK' | 'SDK' — Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration. - `locations` object[] — Locations data - `url` string — Url to download the QR code. (Not yet available from the central bank) - `qr_code` string, required — Information to show the QR code on your payment page, image in base64. - `emv` string, required — EMV string representing the QR code data - `code` string — Standardized error code (applies only for error cases) - `message` string — Message associated with the error code (applies only for error cases) - `return_url` string — The URL you need to redirect the end user back. - BNPLPaymentResponse - `store` object - `code` string — Store identifier. - `category` string — Four-digit ISO 18245 merchant category code. - `transaction` object, required - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction). - `business_id` string — Business ID. The ID of the transaction related with this payment. - `account` integer, required — Client account number. - `amount` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Total amount - `order_id` string — Order ID returned by create payment service - `status` object, required - `type` 'Opened' | 'Pending' | 'Waiting' | 'Published' | 'Collected' | 'Failed', required — Payment status - `reason` 'EmailValidation' | 'WhatsAppValidation' | 'ProviderReview' | 'FirstPayment' — Payment status reason - `date` string, date-time, required — Status change date (ISO 8601 date format) - `error` StatusError — Error details. Present when the payment failed and error information is available. - `code` string — Error code. - `message` string — Error message. - `country_code` string, required — Transaction country code. - `channel` 'API' | 'CHECKOUT' | 'LINK' | 'SDK' — Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration. - `installment_option` object — Selected installment option - `installments` integer — Installments - `installment_rate` string — Installment rate - `installment_amount` number — Installment amount - `total_amount` number — Payment total amount - `currency_code` string — Currency code (ISO 4217) - `first_due_date` string, date-time — Installment first due date (ISO 8601 date format) - `iof` number — IOF rate - `cet` number — CET rate - `cet_am` number — Monthly CET rate - `option_id` string — Installment option identifier - `incoming_percent_value` number — Down payment percentage - `incoming_value` number — Down payment amount - `discount` object - `original_installment_value` number — Original amount before applying the discount - `value` number — Discount amount - `percent` number — Discount percentage - `ui` object - `layout` object - `tags` string[] - `highlighted` boolean - `sorted` number - `hints` object - `birthdate` object - `required` boolean - `return_url` string — The URL you need to redirect the end user back. - `locations` object[] — Locations data - `url` string — Url to download the QR code. (Not yet available from the central bank) - `qr_code` string, required — Information to show the QR code on your payment page, image in base64. - `emv` string, required — EMV string representing the QR code data - `expires` string - `code` string — Standardized error code (applies only for error cases) - `message` string — Message associated with the error code (applies only for error cases) - CardPaymentResponse - `store` object - `code` string — Store identifier. - `transaction` object, required - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction). - `business_id` string — Business ID. The ID of the transaction related with this payment. - `account` string — Client account number. - `amount` object, required - `currency_code` string, required — Currency code (ISO 4217) - `value` number, required — Total amount - `authorization_code` string — Transaction authorization code - `acquirer` string — Transaction acquirer - `commerce_number` string — Transaction commerce number - `provider_reference` object — Provider reference data - `order_id` string — Provider order identifier, used to identify the order in the acquirer - `payment_id` string — Provider payment identifier, used to identify the payment in the acquirer. (Mandatory data when the payment is Collected) - `batch_id` string — Batch identifier from the acquirer (optional) - `ticket_number` string — Ticket number from the acquirer (optional) - `tid` string — Transaction identifier from the acquirer (optional) - `nsu` string — NSU (Número Sequencial Único) from the acquirer (optional) - `order_id` string — Order ID returned by create payment service - `status` object, required - `type` 'Opened' | 'Authorized' | 'Failed', required — Payment status. - `date` string, date-time, required — Status change date (ISO 8601 date format) - `expiration` string, date-time — Status expiration date (ISO 8601 date format) - `reason` string — Payment status reason - `error` StatusError — Error details. Present when the payment failed and error information is available. - `code` string — Error code. - `message` string — Error message. - `country_code` string, required — Transaction country code. - `channel` 'API' | 'CHECKOUT' | 'LINK' | 'SDK' — Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration. - `antifraud` object - `type` 'Approved' | 'Denied' | 'Received' | 'Undefined', required — Antifraud status. - `date` string, date-time, required — Antifraud status date (ISO 8601 date format) - `strategies` object[] — Antifraud strategies - `type` 'VerificationCode' | 'Liveness' | 'ManualVerification' | 'CollectAuthRecovery' — Strategy type - `link` string — URL to access the strategy page - `code` string — Standardized error code (applies only for error cases) - `message` string — Message associated with the error code (applies only for error cases) - `return_url` string — The URL you need to redirect the end user back. ## Other responses - `400` — Bad Request - `404` — Not Found - `409` — Conflict - `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)