---
title: "POST /v2/carnet"
method: POST
path: "/v2/carnet"
---

# POST /v2/carnet

`POST /v2/carnet`

## Request body

- object
  - `IsSandbox` boolean, required — Identifica se a transação vai ser realizada em ambiente sandbox ou não. Quando True deve-se obrigatoriamente informar a chave de API de Sandbox.
  - `Application` string, required — Use para identificar suas aplicações nas transações.
  - `PaymentMethod` integer, required — Informar o código da forma de pagamento Boleto Bancário. Informar o valor: 1 - Boleto Bancário
  - `Customer` object, required — Dados do comprador.
    - `Name` string, required — Nome do comprador.
    - `Identity` string, required — Documento do comprador.
    - `Email` string, required — Email do comprador.
    - `Phone` string, required — Telefone do comprador.
    - `Address` object, required — Dados de endereço comprador.
      - `ZipCode` string, required — CEP do endereço do comprador.
      - `Street` string, required — Logradouro do endereço do comprador.
      - `Number` string, required — Número do endereço do comprador
      - `Complement` string, required — Complemento do endereço do comprador.
      - `District` string, required — Bairro do endereço do comprador.
      - `StateInitials` string, required — UF do endereço do comprador.
      - `CityName` string, required — Cidade do endereço do comprador.
      - `CountryName` string, required — País do endereço do comprador.
  - `Products` object[], required — Lista dos produtos nessa transação.
    - `Code` string, required — Codigo do produto nessa transação.
    - `Description` string, required — Descrição do produto nessa transação.
    - `UnitPrice` number, double, required — Valor unitário do produto nessa transação.
    - `Quantity` string, required — Quantidade do produto nessa transação.
  - `Splits` object[]
    - `CodeTaxType` integer, required — Tipo de repasse, informar 1 para Percentual ou 2 para Valor
    - `IdReceiver` integer, required — Código identificador da empresa no Safe2Pay.
    - `Name` string — Nome da empresa recebedora.
    - `IsPayTax` boolean, required — Informar se a taxa de custo será paga pelo recebedor
    - `Amount` number, double, required — Informar o valor do repasse, em percentual ou valor.
  - `Vendor` string — Nome do vendedor que será vinculado a essa transação.
  - `CallbackUrl` string — URL de notificações de mudança de status da transação.
  - `Reference` string — Use para identificar suas transações.
  - `PaymentObject` object — Dados do pagamento do objeto de retorno.
    - `PenaltyAmount` number, double — Percentual da Multa. Ex: 2.00 - Informar apenas se houver multa.
    - `InterestAmount` number, double — Percentual da Taxa de Juros. Ex: 0.40 - Informar apenas se houver juros.
    - `BankSlips` object[], required
      - `Amount` number, double, required — Valor do boleto.
      - `DueDate` string, date, required — Data de vencimento.
      - `Message` string[] — Mensagens que serão impressas no Boleto. Informar uma lista de até 9 Strings.
      - `DiscountAmount` number, double — Valor do desconto. Informar apenas se houver desconto para o boleto. Valor será adicionado em campo separado no registro.
      - `DiscountType` integer — Indica o tipo de desconto. 1 = valor fixo até o vencimento. 2 = valor por antecipação em dias corridos. 3 = valor por antecipação em dias úteis.
      - `DiscountDue` string, date

## Response `200`

---

[API](https://skmtc.net/safe2pay/apis/payment.md) · [All operations](https://skmtc.net/safe2pay/apis/payment/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safe2pay/payment/versions/8efee77775ac/schema)