---
title: "POST /charges"
method: POST
path: "/charges"
tags: ["Charges"]
---

# POST /charges

`POST /charges`

Criação de uma nova cobrança.<br><br> A autenticação no endpoint é feita da seguinte forma: 
  * **Bearer Token Authorization**: Token JWT.

## Headers

- `Host` string, required

## Request body

- PostChargeRequest
  - `payment_method` 'card', required — Payment method da charge
  - `amount` integer, required — Valor requisitado na cobrança em centavos.
  - `currency_code` string — Código da moeda de autorização da transação. Padrão ISO 3 dígitos. Quando não informado será considerado o valor default 986 (BRL).
  - `initiator_id` string, required — Identificador externo (cliente) que pode ser utilizado em reversões e consultas.
  - `reference_id` string — Identificador externo, geralmente relacionado a um pedido ou outra referência do cliente, apenas em fluxos informacionais.
  - `local_datetime` string, yyyy-MM-ddTHH:mm:ss, required — Data e hora da operação utilizando o fuso horário do local do dispositivo no formato ISO8601.
  - `channel` 'standalone_device' | 'standalone_mobile' | 'website' | 'app' | 'payment_link' — Canal de interação utilizado pelo cliente na inicialização da transação: * `standalone_device` - Dispositivos que processam a transação de forma autônoma e direta (ex. POS). * `standalone_mobile` - Dispositivos mobile que processam a transação de forma autônoma e direta (ex. TapPhone). * `website` - Transações realizadas via ecommerce. * `app` - Transações realizadas via aplicativo. * `payment_link` - Obrigatório para transações realizadas através de link de pagamento.
  - `card_transaction` object — Informações específicas para transações utilizando o método de pagamento cartão
    - `type` 'credit' | 'debit' | 'voucher', required — Tipo de cartão está sendo utilizado na cobrança.
    - `operation_type` 'pre-auth' | 'auth_only' | 'auth_and_capture', required — Informa qual tipo de operação será realizada na autorização: * `pre_auth`: Indica uma pré-autorização que ficará aberta à captura por 30 dias. * `auth_only`: Indica uma autorização padrão, ficando aberta à captura por 07 dias. * `auth_and_capture`: Indica que a captura será realiza de forma automática e imeditada.
    - `installments` integer — Quantidade de parcelas da cobrança. Para cobranças à vista o valor deverá ser 0
    - `installments_type` 'none' | 'issuer' | 'merchant' — Indicação de quem oferece o parcelamento; * `issuer`: Parcelamento oferecido pelo emissor (com juros). * `merchant`: Parcelamento oferecido pelo lojista (sem juros). * `none`: Sem parcelamento (à vista).
    - `statement_descriptor` string — Informação adicional apresentada na filipeta para o comprador final. Em geral o nome fantasia do cliente.
    - `currency_conversion` object
      - `token` string, required — Token contendo os dados da conversão da moeda.
      - `currency_code` string, required — Código da moeda de autorização da transação no cartão do portador. Padrão ISO 3 dígitos
      - `converted_amount` number, required — Valor da transação na moeda de autorização do portador.
    - `card` object, required
      - `number` string, int32, required — Número do cartão (PAN) sendo utilizado na cobrança. OBRIGATÓRIO caso não seja informado um payment_token.
      - `expiration_date` string, YYMM, required — Data de expiração do cartão utilizando o formato ano e mês "YYMM". OBRIGATÓRIO caso não seja informado um payment_token.
      - `entry_mode` 'magstripe' | 'emv' | 'emv_contacless' | 'contactless' | 'qr_code' | 'manual' | 'credentials_on_file', required — Método pelo qual foi realizada a leitura dos dados do cartão: * `magstripe`: Leitura da tarja magnética. * `emv`: Leitura por inserção de ICC, sendo os dados no padrão EMV. * `emv_contactless`: Leitura por aproximação, sendo os dados no padrão EMV. * `contactless`: Leitura por aproximação com tecnologia NFC ou bluetooth, por exemplo, em padrões não EMV. * `qr_code`: Leitura por código QR exibido em um terminal de pagamento.. * `manual`: Dados inseridos manualmente através de uma plataforma de pagamento. * `credentials_on_file`: Dados armazenados previamente.
      - `holder_name` string — Nome do portador do cartão.
      - `holder_document_number` string — Número do documento do portador do cartão.
      - `cvv` string, int32 — Código de segurança do cartão.
      - `emv_data` string — Dados no padrão EMV obtidos do chip do cartão.
      - `track_1` string — Trilha 1 de dados do cartão.
      - `track_2` string — Trilha 2 de dados do cartão.
      - `track_3` string — Trilha 3 de dados do cartão.
      - `sequence_number` string — Identifica um cartão dentro de um conjunto de cartões com o mesmo número de cartão (PAN).
      - `fallback` boolean — Indicação se está sendo utilizado o entry_mode de fallback.
      - `token` object, required — Objeto que contém os dados de tokenização do cartão na bandeira. OBRIGATÓRIO caso não seja informado um número de cartão aberto (number) e data de expiração.
        - `number` string, required — Token gerado pela bandeira.
        - `expiration_date` string, YYMM, required — Data de expiração do token utilizando o formato ano e mês "YYMM".
        - `cryptogram` string — Criptograma do Token.
        - `eci` string — Resultado da autenticação do token: * `02` ou `05`: OK. * `01` ou `06`: Attempted. * `00` ou `07`: Failed.
        - `requestor_id` string — Identificador do requerente do Token.
      - `brand` 'visa' | 'mastercard' | 'amex' | 'hipercard' | 'elo' | 'jcb' | 'aura' | 'dinners' — Bandeira do cartão.
    - `authentication` object
      - `type` 'offline_pin' | 'online_pin' | 'wallet' | 'emv_3ds', required — Método de autenticação do titular do cartão: * `offline_pin`: Autenticação do PIN no ICC do cartão. * `online_pin`: Autenticação criptografada e verificada pelo emissor do cartão. * `wallet`: Autenticação baseada em uma carteira digital. * `emv_3ds`: Autenticação baseada no padrão 3DS
      - `online_pin` object — Dados da autenticação criptografada e verificada pelo emissor do cartão.
        - `algorithm` 'dukpt_3des', required — Algoritmo de criptografia utilizado na senha do cliente.
        - `ksi` string, binary — Identificação usada para derivar uma chave única de uma chave mestra fornecida para os dados proteção.
        - `ksn` string, binary — Chave de criptografia de chave criptografada.
        - `pin_block` string, binary — Dados criptografados, resultado da criptografia de conteúdo.
      - `wallet` object — Dados da autenticação realizada pela carteira digital.
        - `cryptogram` string — Criptograma gerado pelo carteira digital.
        - `eci` '00' | '01' | '02' | '05' | '06' | '07' — Resultado da autenticação: * `02` ou `05`: OK. * `01` ou `06`: Attempted. * `00` ou `07`: Failed.
        - `type` 'applepay' | 'googlepay' | 'clicktopay' — Tipo da Wallet
      - `emv_3ds` object — Dados da autenticação realizada pelo serviço de 3DS.
        - `directory_server_id` string, required — O identificador da transação gerado pelo servidor de 3DS.
        - `cryptogram` string, required — Criptograma gerado pelo serviço de 3DS.
        - `eci` '00' | '01' | '02' | '05' | '06' | '07' | 'DATA_ONLY' — Resultado da autenticação: * `02` ou `05`: OK. * `01` ou `06`: Attempted. * `00` ou `07`: Failed. * `DATA_ONLY`: Data Only.
        - `status` 'Y' | 'N' | 'U' | 'A' | 'R' | 'I' — Resultado da autenticação: * `Y`: Authentication Verification Successful. * `N`: Not Authenticated / Account Not Verified; * `U`: Authentication / Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq. * `A`: Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided. * `R`: Authentication / Account Verification Rejected; Issuer is rejecting authentication/verification and request that auth. * `I`: Data Only.
        - `version` string — Versão do 3DS. Exemplo `VRS21` para indicar 3D Secure 2.1.
        - `xid` string — ID de 3DS retornado no processo de autenticação.
    - `merchant_category_code` string — Código de categoria do lojista ou sublojista relacionado à cobrança.
  - `sub_merchant` object — Dados do cliente que possui o cadastro com a adquirente e está utilizando um facilitador de pagamento.
    - `id` string, required — Identificador do sublojista atribuído pela Subadquirente.
    - `payment_facilitator_id` string — Cadastro do facilitador de pagamento junto as bandeiras.
    - `name` string — Nome do sublojista, para fins informacionais na fatura do comprador. Quando informado tem prioridade sobre o _statement_descriptor_.
    - `document` string, required — Documento do sublojista cadastrado com a adquirente, sem separadores.
    - `document_type` 'cpf' | 'cnpj' | 'passport', required — Tipo de documento usado no cadastro com a adquirente.
    - `email` string — Endereço eletrônico do sublojista.
    - `phone_number` string — Número de telefone do sublojista.
    - `site` string — Endereço do ecommerce do sublojista.
    - `legal_name` string — Razão social do sublojista.
    - `address` object — Endereço de cobrança do sublojista.
      - `street` string — Rua do endereço.
      - `number` string — Número do endereço.
      - `complement` string — Campo para adicionar informações complementares do endereço.
      - `city` string — Cidade do endereço.
      - `state` string — Estado do endereço.
      - `district` string — Bairro do endereço.
      - `country_code` string — Codigo do pais. Padrão ISO 3166. Quando não informado será considerado o valor default "076" (Brasil)
      - `zip_code` string — Código portal do endereço, sem separadores ou espaçamento.
    - `gateway_id` string — Identificador do gateway de pagamentos utilizado pelo sublojista
  - `initiator` object — Indicador de inicialização de transação
    - `initiating_entity` 'account_holder' | 'merchant' — Indica o agente iniciador da transação: * `account_holder`: Indica a participação ativa do comprador na inicialização. * `merchant`: Indica a inicialização pelo lojista.
    - `initiating_reason` 'credentials_on_file' | 'standing_order' | 'subscription' | 'installment' | 'partial_shipment' | 'delayed_charge' | 'no_show' | 'retry' | 'deferred_payment' | 'debit_recovery' | 'installment_payment' | 'marketplace' | 'peer_to_peer' | 'stage_back_to_back' | 'stored_value' | 'bill_payment' | 'card_funds_transfer' — Indica o tipo de transação realizada: * `credentials_on_file`: Transação com credencial (dados de cartão) armazenada (MIT/CIT). * `standing_order`: Ordem Permanente (MIT/CIT). * `subscription`: Assinatura (MIT/CIT). * `installment`: Parcelado (MIT/CIT). * `partial_shipment`: Remessa Parcial (MIT/CIT). * `delayed_charge`: Cobrança atrasada (MIT/CIT). * `no_show`: No show - Multa (MIT/CIT). * `retry`: Reenvio (MIT/CIT). * `deferred_payment`: Pagamento diferido (Mobilidade Urbana). * `debit_recovery`: Recuperação de débito (Mobilidade Urbana). * `installment_payment`: Parcelamento através de mecanismo de recorrência. São realizadas N transações espalhadas por um período de tempo ao invés de uma transação parcelada em N vezes. Esse modelo é utilizado para sensibilizar o saldo do portador de forma parcial ao invés de o valor total de uma só vez. * `marketplace`: Aceitante indireto que oferece sua plataforma de marca. * `peer_to_peer`: Transação que transfere fundos de/para usuários registrados de uma carteira digital. * `stage_back_to_back`: Transação para gerar fundos na carteira digital para o pagamentos de compras e serviços em tempo real. * `stored_value`: Transação que gera fundos na carteira digital para pagamentos subsequentes para um ou vários beneficiários finais. * `bill_payment`: Pagamento de fatura.
  - `first_transaction` object — Dados relacionados a transação original.
    - `brand_transaction_id` string — Identificador da transação original no Emissor.
    - `transaction_id` string — Identificador da transação original emitido pelo provedor (Adquirente).
  - `partner_platform_id` string — Identificador do cliente em provedores externos.
  - `print_line_size` integer — Limite máximo de caracteres por linha na impressão da filipeta.
  - `payee` object — Dados para transações de aporte de recursos.
    - `destination_type` 'digital_wallet' — Tipo de destino da transação.
    - `destination_name` string — Nome do destino do aporte de fundos.
    - `name` string — Nome do destinatário.
    - `document` string — Número do documento do destinatário.
    - `document_type` 'cpf' | 'cnpj' — Tipo de documento do destinatário.
  - `customer` object — Dados do cliente que está realizando a compra.
    - `name` string — Nome do cliente.
    - `document` string — Número do documento do cliente.
    - `document_type` 'cpf' | 'cnpj' | 'passport' — Tipo de documento do cliente.
    - `email` string — Endereço eletrônico do cliente.
    - `phone` object — Número de telefone do cliente.
      - `country` string — Código do país do telefone.
      - `area` string — Código de área do telefone.
      - `number` string — Número do telefone.
      - `type` 'home' | 'work' | 'mobile' — Tipo do telefone.
  - `items` object[] — Lista de itens da compra.
    - `amount` integer — Preço unitário do item em centavos.
    - `description` string — Descrição do item.
    - `quantity` integer — Quantidade do item.
    - `code` string — Código do item.

## Response `200`

OK

- PostChargeResponse
  - `id` string, required — Identificador único da cobrança.
  - `initiator_id` string, required — Identificador externo (cliente) que pode ser utilizado em reversões e consultas.
  - `reference_id` string — Identificador externo, geralmente relacionado a um pedido ou outra referência do cliente, apenas em fluxos informacionais.
  - `amount` integer, required — Valor requisitado na cobrança em centavos.
  - `payment_method` 'card', required — Meio de pagamento da cobrança.
  - `status` 'authorized' | 'paid' | 'canceled' | 'declined', required — Status atual da Charge
  - `created_at` string, yyyy-MM-ddTHH:mm:ssZ, required — Data e hora da criação da cobrança no formato ISO8601.
  - `card_transaction` object
    - `type` 'credit' | 'debit' | 'voucher', required — Detalhamento de que tipo de cartão está sendo utilizado na cobrança.
    - `funding_source` 'credit' | 'debit' | 'prepaid' — Indicação para o método de liquidação a ser utilizado.
    - `result` 'success' | 'failed', required — Resultado da operação que foi executada
    - `transaction_id` string, required — Identificador da transação emitido pelo provedor (Adquirente).
    - `operation_id` string, required — Identificador da operação gerado pela adquirente.
    - `brand_transaction_id` string — Identificador da transação no Emissor.
    - `authorization_code` string — Código de autorização.
    - `acquirer_message` string — Mensagem de resultado da operação retornada pela adquirente.
    - `acquirer_return_code` string, required — Código de resultado da operação retornado pela adquirente.
    - `brand_return_code` string — Código de retorno ABECS.
    - `merchant_advice_code` string — código de retorno do padrão MAC.
    - `additional_data` object[] — Detalhamento de informações adicionais
      - `name` string, required — Nome da propriedade adicional
      - `value` string, required — Valor da propriedade adicional
    - `card` object, required
      - `brand` string, required — Bandeira do cartão
      - `remaining_balance` integer — Saldo disponível no cartão, caso seja informado pela adquirente
      - `emv_response` string, binary — EMV
      - `payment_account_reference` string — Referência exclusiva ao cartão, usada por comerciantes e adquirentes para vincular transações tokenizadas e não tokenizadas associadas ao mesmo cartão subjacente (PAR).

## Other responses

- `400` — BadRequest
- `401` — Não autorizado

---

[API](https://skmtc.dev/stone/apis/payments-processing-acquiring-paymentcardapi.md) · [All operations](https://skmtc.dev/stone/apis/payments-processing-acquiring-paymentcardapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/stone/payments-processing-acquiring-paymentcardapi/revisions/29bc4962fa98/schema)