Sign in

v1

latestOpenAPI 3.0.32026-07-265974.7 KB
Charges

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

  • Bearer Token Authorization: Token JWT.
post/charges

Headers

Hoststring required

Domínio utilizado para processar a requisição. Neste caso, determina o ambiente do serviço, podendo ter os valores:

  • payments.stone.com.br: ambiente produtivo
  • sdx-payments.stone.com.br: ambiente de sandbox (pré-produção)

Request body

payment_method'card' required

Payment method da charge

amountinteger required

Valor requisitado na cobrança em centavos.

currency_codestring

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_idstring required

Identificador externo (cliente) que pode ser utilizado em reversões e consultas.

reference_idstring

Identificador externo, geralmente relacionado a um pedido ou outra referência do cliente, apenas em fluxos informacionais.

local_datetimestring 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.
partner_platform_idstring

Identificador do cliente em provedores externos.

print_line_sizeinteger

Limite máximo de caracteres por linha na impressão da filipeta.

Example request

{
  "card_transaction": {
    "authentication": {
      "online_pin": {
        "ksi": "2020080303",
        "ksn": "398A00137C",
        "pin_block": "9DDBB990C440FB0D"
      }
    }
  }
}

Response

OK

idstring required

Identificador único da cobrança.

initiator_idstring required

Identificador externo (cliente) que pode ser utilizado em reversões e consultas.

reference_idstring

Identificador externo, geralmente relacionado a um pedido ou outra referência do cliente, apenas em fluxos informacionais.

amountinteger 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_atstring yyyy-MM-ddTHH:mm:ssZ required

Data e hora da criação da cobrança no formato ISO8601.