--- title: "Criar Pedido de Pagamento" method: POST path: "/order/" tags: ["Pedidos"] --- # Criar Pedido de Pagamento `POST /order/` É possível realizar a criação de pagamentos com múltiplos meios de pagamento, dependendo da necessidade do usuário. > ❗️ **Informações do cliente são necessárias** > > Se o `customer_id` for fornecido, a inclusão do objeto `customer` não é obrigatória. No entanto, é importânte que pelo menos um desses parâmetros seja informado. ## Request body - OrderRequestDTO - `items` OrderItemRequestDTO[], required — Itens do pedido - `product_id` string, required — Id do produto - `amount` union, required — Valor unitário do produto - number - string - `description` string, nullable, required — Descrição do produto - `type` union, required — Tipo do item - 'vehicle_debt' | 'other' | 'batch_payment' | 'insurance' | 'debt_search' - 'services' | 'ticket' | 'ipva' | 'licensing' | 'ipva-unique' | 'ipva-installment' | 'insurance' | 'expired_insurance' - `metadata` object, nullable — Dados adicionais do item - `payments` PaymentRequestDTO[], required — Lista de dados de cobrança - `payment_method` 'credit_card' | 'debit_card' | 'voucher' | 'bank_slip' | 'pix' | 'cash' | 'tokenized_credit_card', required - `amount` union — Valor total do pedido - number - string - `credit_card` CreditCardRequestDTO - `installments` integer — Número de parcelas - `statement_descriptor` string, nullable — Descrição que aparecerá na fatura do cliente - `operation_type` 'authorize_and_capture' | 'authorize_only' | 'pre_authorize' | 'capture' | 'cancel' - `card` CardRequestDTO - `number` string, required — Número do cartão - `holder_name` string, required — Nome do titular do cartão - `holder_document` string, required — Documento do titular do cartão - `exp_month` integer, required — Mês de expiração - `exp_year` integer, required — Ano de expiração - `cvv` string, required — Código de segurança - `brand` 'visa' | 'mastercard' | 'elo' | 'hipercard' | 'unionpay' | 'maestro' | 'dinersclub' | 'discover' | 'sorocred' | 'jcb' | 'ticketlog', required - `billing_address` CustomerAddressRequestDTO, required - `zip_code` string, required — CEP - `line_1` string, required — Endereço - `line_2` string, nullable — Complemento - `state` string, required — Estado - `city` string, required — Cidade - `card_token` string, nullable — Token do cartão - `card_hash` string, nullable — Cartão criptografado - `bank_slip` BankSlipRequestDTO - `name` string, nullable — Nome do cliente - `document` string, required — CPF ou CNPJ do cliente - `pix` PixRequestDTO - `expires_in` string, required — Tempo de expiração - `expires_at` string, required — Data de expiração - `additional_information` AdditionalInformationRequestDTO, required - `name` string, required — Nome - `document` string, required — Documento - `voucher` VoucherRequestDTO - `statement_descriptor` string, nullable — Descrição que aparecerá na fatura do cliente - `card` CardRequestDTO, required - `number` string, required — Número do cartão - `holder_name` string, required — Nome do titular do cartão - `holder_document` string, required — Documento do titular do cartão - `exp_month` integer, required — Mês de expiração - `exp_year` integer, required — Ano de expiração - `cvv` string, required — Código de segurança - `brand` 'visa' | 'mastercard' | 'elo' | 'hipercard' | 'unionpay' | 'maestro' | 'dinersclub' | 'discover' | 'sorocred' | 'jcb' | 'ticketlog', required - `billing_address` CustomerAddressRequestDTO, required - `zip_code` string, required — CEP - `line_1` string, required — Endereço - `line_2` string, nullable — Complemento - `state` string, required — Estado - `city` string, required — Cidade - `customer` CustomerRequestDTO - `name` string, required — Nome do cliente - `email` string, required — E-mail do cliente - `phone` string, required — Telefone do cliente - `document` string, required — Documento do cliente - `address` CustomerAddressRequestDTO - `zip_code` string, required — CEP - `line_1` string, required — Endereço - `line_2` string, nullable — Complemento - `state` string, required — Estado - `city` string, required — Cidade - `metadata` object, nullable — Dados adicionais do cliente - `discount_code` string, nullable — Cupom de desconto à ser aplicado no pedido, - `customer_id` string, nullable — Id do cliente. Obrigatório caso o customer não seja informado. - `closed` boolean — Indica se o pedido está aberto ou fechado - `ip_address` string, nullable — Endereço IP do dispositivo que solicitou a compra - `session_id` string, nullable — Código de sessão do usuário - `device` object, nullable — Dados do dispositivo utilizado na compra - `metadata` object, nullable — Dados adicionais do pedido - `antifraud_enabled` boolean — Indica se o antifraude está habilitado - `external_id` string, nullable — Id externo - `antifraud_info` OrderRequestAntifraudInfo - `last_purchase_decision` 'approved' | 'denied' - `days_since_first_purchase` integer, nullable — Dias desde a primeira compra do cliente. - `first_purchase_amount` number, nullable — Valor da primeira compra realizada. - `first_purchase_payment_type` 'credit_card' | 'debit_card' | 'voucher' - `purchase_history_count` integer, nullable — Quantidade de compras realizadas pelo cliente. - `was_chargeback` boolean, nullable — Indica se já houve chargeback associado ao cliente. - `days_since_last_purchase` integer, nullable — Dias desde a última compra. - `cards_used_last_year` integer, nullable — Número de cartões utilizados no último ano. - `customer_purchase_history_count` integer, nullable — Total de compras no histórico do cliente. - `customer_account_age` integer, nullable — Tempo de criação da conta do cliente, em dias. - `metadata` object, nullable — Metadados adicionais relacionados à análise antifraude. - `amount` union — Valor total do pedido - number - string ## Response `200` Pedido criado com sucesso - union - OrderResponseDTO - `order_id` string, required - OrderDetailResponseDTO - `order_id` string, required - `closed` boolean, required - `items` ItemResponseDTO[], required - `product_id` string, required - `amount` number, required - `type` string, nullable - `status` 'pending' | 'processing' | 'paid' | 'canceled' | 'failed' | 'settled', required - `description` string, nullable - `metadata` object, nullable - `customer` CustomerResponseDTO - `name` string, required - `phone` string, nullable - `email` string, nullable - `document` string, nullable - `address` V2PackagesEnterpriseSchemasOrderOrderResponseSchemasAddressResponseDTO - `zip_code` string, nullable - `state` string, nullable - `city` string, nullable - `line_1` string, nullable - `line_2` string, nullable - `metadata` object - `metadata` object - `status` 'pending' | 'processing' | 'paid' | 'canceled' | 'cancellation_requested' | 'failed', required - `closed_at` string, nullable - `external_id` string, nullable - `charges` V2PackagesEnterpriseSchemasOrderOrderResponseSchemasChargeResponseDTO[], required - `charge_id` string, required - `code` string, nullable - `gateway_id` string, nullable - `amount` number, required - `original_amount` number, nullable - `status` string, required - `payment_method` string, nullable - `paid_at` string, date-time, nullable - `last_transaction` V2PackagesEnterpriseSchemasOrderOrderResponseSchemasLastTransactionResponseDTO - `transaction_id` string, required - `transaction_type` string, required - `amount` number, required - `status` string, nullable - `success` boolean, nullable - `installments` integer, nullable - `operation_type` string, nullable - `gateway_id` string, nullable - `acquirer_name` string, nullable - `acquirer_transaction_id` string, nullable - `acquirer_nsu` string, nullable - `acquirer_auth_code` string, nullable - `acquirer_message` string, nullable - `acquirer_return_code` string, nullable - `card` V2PackagesEnterpriseSchemasOrderOrderResponseSchemasCardResponseDTO - `last_four_digits` union - string - integer - `brand` string, nullable - `holder_name` string, nullable - `exp_month` integer, nullable - `exp_year` integer, nullable - `status` string, nullable - `billing_address` V2PackagesEnterpriseSchemasOrderOrderResponseSchemasAddressResponseDTO - `zip_code` string, nullable - `state` string, nullable - `city` string, nullable - `line_1` string, nullable - `line_2` string, nullable - `metadata` object - `type` string, nullable - `created_at` string, date-time - `updated_at` string, date-time - `bank_slip` BankSlipResponseDTO - `line` string, nullable - `barcode` string, nullable - `url` string, nullable - `pdf` string, nullable - `qr_code` string, nullable - `nosso_numero` string, nullable - `document_number` string, nullable - `instructions` string, nullable - `due_at` string, date-time, nullable - `pix` PixResponseDTO - `qr_code` string, nullable - `qr_code_url` string, nullable - `additional_information` object, nullable - `created_at` string, date-time - `updated_at` string, date-time - `gateway_response` V2PackagesEnterpriseSchemasOrderOrderResponseSchemasGatewayResponseDTO - `name` string, nullable - `message` string, nullable - `code` string, nullable - `metadata` object, nullable - `antifraud_response` V2PackagesEnterpriseSchemasOrderOrderResponseSchemasAntifraudResponseDTO - `name` string, nullable - `status` string, nullable - `message` string, nullable - `code` string, nullable - `score` integer, nullable - `metadata` object, nullable - `chargeback_reason` ChargebackReasonDTO - `chageback_date` string, date-time, nullable - `reason` string, nullable - `code` string, nullable - `justification` string, nullable - `created_at` string, date-time - `updated_at` string, date-time - `created_at` string, nullable - `updated_at` string, nullable - `metadata` object ## Other responses - `400` — Falha ao criar pedido - `422` — Falha ao criar pedido ada --- [API](https://skmtc.net/usezapay/apis/zapi.md) · [All operations](https://skmtc.net/usezapay/apis/zapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usezapay/zapi/versions/50c96157fff4/schema)