---
title: "Criar cobrança"
method: POST
path: "/baas/v1/cash/charges"
tags: ["Cobranças"]
---

# Criar cobrança

`POST /baas/v1/cash/charges`

## Query parameters

- `account` integer, required

## Request body

- object
  - `Customer` object
    - `name` string
    - `document` string, utc-millisec
    - `emails` string[]
  - `payday` string, date
  - `mainPaymentMethodId` string
  - `value` integer
  - `PaymentMethodCreditCard` object
    - `Card` object
      - `number` string
      - `holder` string
      - `expiresAt` string
      - `cvv` string
      - `cryptData` string
      - `galaxPayId` integer — Caso seja necessário usar um cartão já criado anteriormente, utilize apenas este campo.
    - `3DS` object
      - `InternalEMV` object — Informações da validação 3ds interna Clique para ver os campos.
        - `userAgent` string — Identificador do browser utilizado pelo comprador no momento da compra.
        - `ip` string, required — Suporta informações somente em iPv4
        - `Device` object, required
          - `colorDepth` string, required — Campo que representa a estimativa da paleta de cores usada para a exibição de imagens, em bits por pixel. Obtido no navegador do cliente através da propriedade.
          - `deviceType3ds` string, required — Campo que indica tipo de dispositivo no qual a autenticação ocorre.
          - `javaEnabled` false | true, required — Campo booleano que representa a capacidade do navegador para executar Java. O valor é aquele retornado pela propriedade navigator.javaEnabled, true ou false.
          - `language` string, required — Idioma do navegador no formato IETF BCP47, contendo entre 1 e 8 caracteres.
          - `screenHeight` string, required — A altura total da tela do cliente em pixels. O valor é aquele retornado pela propriedade screen.height.
          - `screenWidth` string, required — A largura total da tela do cliente em pixels. O valor é aquele retornado pela propriedade screen.width.
          - `timeZoneOffset` string — Diferença de horário, em horas, entre o UTC e a hora local do navegador do titular do cartão.
        - `redirectUrl3ds` string, required — Campo que indica para qual URL o cliente será direcionado após o desafio 3ds.
      - `ExternalEMV` object — Nó de 3DS externo
        - `embedded` true | false
        - `cavv` string, required — Código do criptograma utilizado na autenticação da transação e enviado pelo MPI do estabelecimento (pode conter caracteres especiais).
        - `eci` string, required — O parâmetro ECI (Eletronic Commerce Indicator) se baseia no valor retornado ao MPI pelas Bandeiras que indica o resultado da autenticação do portador junto ao Emissor.
        - `xid` string, required — ID da transação de autenticação enviado pelo MPI ao estabelecimento (pode conter caracteres especiais). Deve ser enviado apenas para a utilização do serviço de autenticação 3DS. Campo utilizado somente para bandeira ***Visa.
        - `threeDIndicator` string, required — Versão do 3DS usado no processo de autenticação pelo MPI.
        - `directoryServerTransactionId` string, required — ID da transação de autenticação incluída pelo MPI ao estabelecimento (pode conter caracteres especiais). Deve ser enviado apenas para a utilização do serviço de autenticação 3DS.
    - `Antifraud` object — Informações para enviar para o Antifraude. Clique para ver os campos.
      - `ip` string, required — IPv4/IPv6 do cliente.
      - `sessionId` string
      - `Billing` object
        - `name` string — Nome do comprador
        - `address1` string, required — Endereço primário da fatura
        - `address2` string — Endereço secundário da fatura(se houver)
        - `city` string — Cidade do titular do cartão
        - `state` string — Estado do titular
        - `zip` string — CEP do titular
        - `country` string — Código do país titular ISO 3166-2
      - `Cart` object
        - `sku` string — SKU ou número de inventário do produto ou serviço.
        - `productCode` string — Código de barras ou UPC do produto ou serviço.
        - `name` string — Nome do comprador
        - `description` string — Alguma informação referente ao desconto.
        - `unitCost` number — Custo unitário deste produto ou serviço.
        - `quantity` number — Quantidade de unidades compradas.
        - `discount` number
        - `createdAt` string, date — Data de publicação do produto no site, em formato YYYY-MM-DD
        - `deliveryType` string — Tipo de entrega.
        - `deliverySlaInMinutes` integer — Tempo estimado de entrega em minutos.
        - `sellerId` string — Identificação do vendedor.
      - `Customer` object — Pessoa que está fazendo a compra Clique para ver os campos.
        - `id` string, required — Identificador único do cliente. Pode ser qualquer valor (sequencial, documento, e-mail) desde que seja consistente em pedidos futuros.
        - `dateOfBirth` string, date — Data de nascimento do cliente no formato YYYY-MM-DD
        - `documentType` 'CPF' | 'CNPJ' | 'RG' | 'PASSPORT' | 'OTHER' | 'CPF_CNPJ' — Tipo do documento fiscal do cliente (CPF, CNPJ, RG, PASSPORT, OTHER, CPF_CNPJ).
        - `phone1` string — Número de telefone primário do cliente
        - `phone2` string — Número de telefone secundário do cliente
        - `new` true | false — Flag indicando se o cliente está usando uma conta recém-criada nesta compra.
        - `vip` true | false — Flag indicando se este é um cliente VIP ou comprador frequente.
        - `type` string — Identificador do tipo do cliente.
        - `riskLevel` 'low' | 'medium' | 'hight' — Identificador do nível de risco.(low, medium ou high)
        - `riskScore` number — Identificador do score de risco do cliente.
        - `motherName` string — Nome completo da mãe do cliente.
      - `Device` object — Informações da máquina que seu cliente usa para efetuar a transação em sua loja. Clique para ver os campos.
        - `fingerprint` string, required — Identificação do navegador(min 3, max 255)
        - `provider` string — Tipo de provedor (min 2, max 255)
        - `model` string — Tipo do modelo utilizado(max 255 chars)
        - `platform` string — Tipo de dispositivo pelo cliente
        - `manufacturer` string — Fabricante(min 2, max 255 chars)
        - `os` string — Qual sistema operacional (min 2, max 255 chars)
        - `browser` string — Navegador (min 2, max 255 chars)
        - `language` string — Linguagem utilizada
      - `Payment` object
        - `bin` string — Identificação do cartão - primeiros 6 a 10 números.
        - `last4` string — Os últimos quatro dígitos do cartão de crédito.
        - `expirationDate` string — Data de validade do cartão no formato MMAAAA.
        - `description` string — Alguma informação referente ao desconto.
        - `taxId` string — CPF do portador do cartão
        - `cvvResult` string — Código de resultado da verificação CVV (verificação do cartão).
        - `avsResult` string — Código de resultado da verificação do AVS (Serviço de Verificação de Endereço).
        - `sha1` string — Código de pagamento de integridade (É um HMAC-SHA-256 dos campos da notificação)
        - `name` string — Nome do comprador
        - `holder` string — Nome do portador do cartão de crédito.
        - `amount` number — Valor total do pedido.
  - `Split` object
    - `creditcard` object
      - `type` 'percent' | 'fixed'
      - `Companies` object[]
        - `numberAccount` integer, required
        - `value` integer, required

## Response `200`

Success

- object
  - `type` boolean
  - `Charge` object
    - `myId` unknown
    - `galaxPayId` integer
    - `value` integer
    - `paymentLink` string, uri
    - `mainPaymentMethodId` string
    - `status` string
    - `additionalInfo` unknown
    - `createdAt` string, style
    - `updatedAt` string
    - `payedOutsideGalaxPay` boolean
    - `Customer` object
      - `myId` unknown
      - `galaxPayId` integer
      - `name` string
      - `document` string, utc-millisec
      - `createdAt` string, style
      - `updatedAt` string
      - `emails` string[]
      - `phones` unknown[]
        - unknown
      - `Address` object
        - `zipCode` unknown
        - `street` unknown
        - `number` unknown
        - `complement` unknown
        - `neighborhood` unknown
        - `city` unknown
        - `state` unknown
      - `ExtraFields` unknown[]
        - unknown
    - `Transactions` object[]
      - `galaxPayId` integer
      - `value` integer
      - `payday` string, date
      - `paydayDate` unknown
      - `installment` integer
      - `status` string
      - `statusDescription` string
      - `statusDate` string, style
      - `createdAt` string
      - `datetimeLastSentToOperator` unknown
      - `chargeGalaxPayId` integer
      - `chargeMyId` unknown
      - `ConciliationOccurrences` unknown[]
        - unknown
    - `ExtraFields` unknown[]
      - unknown
    - `PaymentMethodCreditCard` object
      - `cardOperatorId` unknown
      - `preAuthorize` boolean
      - `qtdInstallments` integer
      - `Link` object
        - `minInstallment` integer
        - `maxInstallment` integer

## Other responses

- `400` — Bad request
- `401` — Unauthenticated
- `500` — Internal Server error

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/revisions/85dd6188a37b/schema)