--- title: "Criar transação" method: POST path: "/v1/marketplace/transactions" tags: ["Transações"] --- # Criar transação `POST /v1/marketplace/transactions` ## Headers - `integration-key` string, required - `x-token` string, required - `establishment_id` string, required ## Request body - CreateTransactionDto - `payment_type` 'CREDIT' | 'PIX' | 'BILLET', required — Tipo de transação. - CREDIT: Crédito. - PIX - `amount` number, required — Valor da transação em centavos. - `installments` number — Quantidade de parcelas. Obrigatório somente para transações do tipo crédito. - `interest` 'STORE' | 'CLIENT', required — - CLIENT: o valor das taxas serão repassadas ao cliente, aumentando o valor bruto da transação. - STORE: o valor das taxas serão cobradas do estabelecimento, mantendo o valor bruto da transação. - `client` TransactionClient - `first_name` string, required — Nome / razão social do cliente. - `last_name` string — Sobrenome / nome fantasia do cliente. - `document` string, required — CPF / CNPJ do cliente. - `phone` string — Número de telefone do cliente. - `email` string, required — E-mail do cliente. - `address` Address - `street` string, required — Logradouro. - `number` string, required — Número. - `complement` string — Complemento. - `neighborhood` string, required — Bairro. - `city` string, required — Cidade. - `state` 'AC' | 'AL' | 'AP' | 'AM' | 'BA' | 'CE' | 'DF' | 'ES' | 'GO' | 'MA' | 'MS' | 'MT' | 'MG' | 'PA' | 'PB' | 'PR' | 'PE' | 'PI' | 'RJ' | 'RN' | 'RS' | 'RO' | 'RR' | 'SC' | 'SP' | 'SE' | 'TO', required — Estado. - `zip_code` string, required — CEP. - `card` TransactionCard - `holder_name` string, required — Nome do portador do cartão. - `holder_document` string, required — CPF / CNPJ do portador do cartão. - `card_number` string, required — Número do cartão. Deve ter de 13 a 16 dígitos. - `expiration_month` number, required — Mês de expiração do cartão (1 a 12). - `expiration_year` number, required — Ano de expiração. - `security_code` string, required — Código de segurança. Deve ter 3 ou 4 dígitos. - `create_token` boolean — Gerar token com os dados do cartão. - `token` string — Token gerado do cartão. - `billet` TransactionBilletDto - `due_date` string, required — Data de vencimento do boleto, no formato YYYY-MM-DD. - `issue_date` string, required — Data de emissão do boleto, no formato YYYY-MM-DD. - `document_kind` string — Espécie do documento (padrão = OUTROS) - `days_until_expiration` number — Quantidade de dias após o vencimento até que o boleto expire e não possa mais ser pago. - `iof_percentage` string — Percentual de IOF no formato 0.00000 (ex: 0.00820). Aplicado sobre o valor do boleto. - `messages` string[] — Mensagens de instrução exibidas no boleto (máximo de 3 linhas). - `discount` BilletDiscount - `type` 'VALOR_DATA_FIXA', required — Tipo de desconto. - `items` BilletDiscountItem[], required — Lista de descontos com até 3 itens. - `limit_date` string, required — Data limite para aplicação do desconto, no formato YYYY-MM-DD. Obrigatório apenas para descontos do tipo VALOR_DATA_FIXA - `value` number, required — Valor do desconto em centavos. - `fine` BilletFine - `percentage` string, required — Percentual de multa no formato 0.00 (ex: 2.00 representa 2%). - `quantity_days` number, required — Quantidade de dias de multa. - `interest_percentage` string — Percentual de juros ao mês no formato 0.00 (ex: 1.00 representa 1%). - `session_id` string — ID da sessão de antifraud. - `info_additional` InfoAdditionalDto[] — Informações adicionais. Utilizado para transações do tipo PIX. - `key` string, required — Chave - `value` string, required — Valor da chave - `split` SplitDto - `title` string, required — Título do split. - `division` 'PERCENTAGE' | 'CURRENCY', required — Regra de divisão do split. - `establishments` SplitEstablishmentDto[], required — Detalhes dos estabelecimentos participantes do split. - `id` number, required — ID do estabelecimento. - `value` number, required — Valor do split. Em centavos para a regra de divisão igual à "CURRENCY". Em porcentagem para a regra de divisão igual à "PERCENTAGE" - `reference_id` union — Identificador definido pelo cliente para controle e rastreamento interno da transação. - string - number - `antifraud_type` 'THREEDS' | 'IDPAY' — Tipo de antifraude utilizado. - THREEDS: Antifraude 3DS. - IDPAY: Antifraude IDPAY. ## Response `200` - CreateTransactionClientResponse - `_id` string, required — Identificador único da transação. - `status` 'CREATED' | 'PENDING' | 'APPROVED' | 'PAID' | 'FAILED' | 'REFUNDED' | 'DISPUTED' | 'CANCELED' | 'CHARGEBACK', required — Status da transação. - `amount` number, required — Valor líquido em centavos. - `original_amount` number, required — Valor bruto em centavos. - `interest` 'STORE' | 'CLIENT', required — - CLIENT: o valor das taxas serão repassadas ao cliente, aumentando o valor bruto da transação. - STORE: o valor das taxas serão cobradas do estabelecimento, mantendo o valor bruto da transação. - `fees` number, required — Valor total de taxas em centavos. - `establishment` Establishment, required - `first_name` string, required — Nome fantasia ou nome do responsável. - `last_name` string, required — Razão social. - `document` string, required — CPF ou CNPJ. - `type` 'INDIVIDUAL' | 'BUSINESS', required — Tipo do estabelecimento, BUSINESS (Pessoa jurídica) ou INDIVIDUAL (Pessoa física). - `access_type` 'ACQUIRER' | 'BANKING', required — Tipo de acesso, ACQUIRER (Adquirência) ou BANKING (Conta digital). - `id` number, required — Identificador único do estabelecimento. - `marketplace` Marketplace, required - `id` number, required — Id único do marketplace. - `type` 'WHITELABEL' | 'LICENSED' | 'REPRESENTATIVE', required — Tipo do marketplace. - `nickname` string, required — Nome público ou apelido. - `active` boolean, required — Indica se o marketplace está ativo. - `first_name` string, required — Nome fantasia ou nome do responsável. - `last_name` string, required — Razão social ou sobrenome. - `document` string, required — CPF ou CNPJ. - `representative` Representative, required - `id` number, required — Identificador único do representante. - `marketplace_id` number, required — ID do marketplace. - `active` boolean, required — Indica se o representante está ativo. - `first_name` string, required — Nome fantasia ou nome do responsável. - `last_name` string, required — Razão social ou sobrenome. - `document` string, required — CPF ou CNPJ. - `type` 'CREDIT' | 'DEBIT' | 'PIX' | 'BILLET', required — Tipo da transação. - `gateway_authorization` 'PAYTIME' | 'ZOOP' | 'PAGSEGURO', required — Subadquirente responsável pela transação. - `card` Card, required - `brand_name` string, required — Bandeira. - `first4_digits` string, required — Primeiros 4 dígitos. - `last4_digits` string, required — Últimos 4 dígitos. - `expiration_month` string, required — Mês de expiração. - `expiration_year` string, required — Ano de expiração. - `holder_name` string, required — Nome do portador. - `token` string, required — Token do cartão - `installments` number, required — Número de parcelas. - `customer` Customer, required - `first_name` string, required — Nome completo (pessoa física) ou razão social (pessoa jurídica). - `last_name` string — Razão social (Pessoa jurídica). - `document` string, required — CPF ou CNPJ. - `phone` string — Número de telefone ou celular. - `email` string — Endereço de e-mail. - `point_of_sale` PointOfSale, required - `type` 'ONLINE' | 'CHIP' | 'TAP' | 'SMART', required — Modalidade - ONLINE: venda online. - CHIP: venda presencial. - TAP: venda presencial via Tap on Phone , - SMART: venda presencial via A960 - `identification_type` 'CHIP' | 'CONTACTLESS' | 'MAGNETIC' | 'LINK' | 'API' | 'CHECKOUT' — - CHIP: normal. - CONTACTLESS: aproximação. - MAGNETIC: cartão passado. - LINK: link de pagamento. - API: transação via API. - CHECKOUT: transação via smart checkout. - `identification_number` string — Número de identificação. - `acquirer` Acquirer, required - `name` string, required - `nsu` number, required - `acquirer_nsu` number, required - `end_to_end` string, required - `key` string, required - `gateway_key` string, required - `authorization_number` string, required - `expected_on` ExpectedOn[], required — Lista de detalhes das parcelas. - `installment` number, required — Número da parcela. - `date` string, date-time, required — Data de liquidação da parcela. - `paid_at` string, date-time — Data de pagamento da parcela. Exibida apenas quando o status da parcela for "PAID". - `amount` number, required — Valor da parcela em centavos. - `status` 'PENDING' | 'PAID' | 'CANCELED' | 'REFUNDED' | 'FAILED', required — Status da parcela. PENDING: Pendente; PAID: Liquidada; CANCELED: Cancelada; REFUNDED: Estornada; FAILED: Falha. - `created_at` string, date-time, required — Data da transação. - `emv` string — Código "copia e cola" de transações do tipo Pix. - `antifraud` AntifraudSession[] — Informações da análise de antifraude, caso executada. - `analyse_required` 'THREEDS' | 'CLEARSALE' | 'IDPAY', required — Tipo de antifraude requerido. - `analyse_status` 'APPROVED' | 'PROCESSING' | 'WAITING_AUTH' | 'FAILED' | 'NO_ANALYSED', required — Status da análise de antifraude. - `antifraud_id` string — ID de identificação da transação no antifraude. - `session` string — ID da sessão de antifraude. - `payment_response` PaymentResponse - `code` string, required — Código da adquirente que indica o motivo da resposta de autorização no pagamento, tanto para pagamento autorizado quanto para negado. - `message` string, required — Mensagem amigável que descreve o motivo da não aprovação ou autorização da cobrança. Compatível com o padrão ABECS - Normativo 21. - `reference` string — NSU da autorização, caso o pagamento seja aprovado pelo emissor. - `authorization_code` string — Código de autorização para realizar a transação, gerado pelo emissor do cartão. - `nsu` string — O número sequencial único (NSU) é um código de 12 dígitos que identifica uma transação. - `reason_code` string — Código do motivo de compra negada enviada pela bandeira do cartão, são ABECS compliance, seguindo normativa nº021. -> link da norma em https://api.abecs.org.br/wp-content/uploads/2019/09/Normativo-021.pdf - `info_additional` InfoAdditionalResponse[] — Informações adicionais da transação. - `key` string, required — Chave - `value` string, required — Valor da chave - `split` TransactionSplitResponse - `active` boolean, required — Indica se a transação possui split ativo. - `is_origin` boolean, required — Indica se é a transação que originou o split. - `processing` boolean, required — Indica se a transação está em processo de split ou de cancelamento de split. - `initial_amount` number — Valor original da transação principal. Informado apenas caso a transação seja a que originou o split. - `reference_id` string — Identificador definido pelo cliente para controle e rastreamento interno da transação. - `billet` BilletResponse - `due_date` string, required — Data de vencimento do boleto, no formato YYYY-MM-DD. - `issue_date` string, required — Data de emissão do boleto, no formato YYYY-MM-DD. - `entry_date` string — Data de entrada/registro do boleto, no formato YYYY-MM-DD. - `document_kind` 'DUPLICATA_MERCANTIL' | 'DUPLICATA_SERVICO' | 'NOTA_PROMISSORIA' | 'NOTA_PROMISSORIA_RURAL' | 'RECIBO' | 'APOLICE_SEGURO' | 'BOLETO_CARTAO_CREDITO' | 'BOLETO_PROPOSTA' | 'BOLETO_DEPOSITO_APORTE' | 'CHEQUE' | 'NOTA_PROMISSORIA_DIRETA' | 'OUTROS' — Espécie do documento. - `iof_percentage` string — Percentual de IOF no formato 0.00000. - `messages` string[] — Mensagens de instrução exibidas no boleto (máximo de 3 linhas). - `digitable_line` string — Linha digitável do boleto. - `barcode` string — Código de barras do boleto. - `qr_code_pix` string — Payload do QR Code Pix do boleto, para pagamento via Pix. - `qr_code_url` string — URL do QR Code Pix do boleto. - `pdf_url` string — URL do PDF do boleto gerado. - `configured_amount` number — Valor configurado do boleto em centavos (após descontos/acréscimos). - `configured_original_amount` number — Valor original configurado do boleto em centavos. - `discount` BilletDiscountResponse - `type` 'VALOR_DATA_FIXA', required — Tipo de desconto. - `items` BilletDiscountItemResponse[], required — Lista de descontos com até 3 itens. - `value` number, required — Valor do desconto em centavos. - `limit_date` string, required — Data limite para aplicação do desconto, no formato YYYY-MM-DD. - `fine` BilletFineResponse - `percentage` string, required — Percentual de multa no formato 0.00 (ex: 2.00 representa 2%). - `quantity_days` number, required — Quantidade de dias de multa. - `interest_percentage` string — Percentual de juros ao mês no formato 0.00 (ex: 1.00 representa 1%). - `payment` BilletPaymentResponse - `paid_via` 'QRCODE' | 'BARCODE', required — Meio pelo qual o boleto foi pago. - `date` string, date-time, required — Data do pagamento do boleto. - `paid_amount` number, required — Valor pago em centavos. - `interest_value` number, required — Valor de juros cobrado em centavos. - `fine` number, required — Valor de multa cobrado em centavos. - `deduction_value` number, required — Valor de desconto aplicado em centavos. - `iof_value` number, required — Valor de IOF recolhido em centavos. --- [API](https://skmtc.net/paytime/apis/api-p-blica.md) · [All operations](https://skmtc.net/paytime/apis/api-p-blica/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paytime/api-p-blica/versions/5c818991d183/schema)