DocsAPI ReferenceChangelogFórum
Log In
API Reference

Autorização

Criação de uma nova cobrança.

📘

Header Host conforme o modelo de negócio

Para atender às regras específicas de autenticação, descritas neste link, é necessário que o Header Host das suas requisições seja ajustado de acordo com o seu modelo de negócio.

Se você é um Gateway de Pagamentos, utilize o Header Host:
ecommerce-payments.stone.com.br

Se você é uma Subadquirente, utilize o Header Host:
payments.stone.com.br

Body Params
string
enum
required

Payment method da charge

Allowed:
int64
required

Valor requisitado na cobrança em centavos.

string
length between 3 and 3

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).

string
required
length ≤ 123

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

string
length ≤ 128

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

string
required

Data e hora da operação utilizando o fuso horário do local do dispositivo no formato ISO8601.

string
enum

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.
Allowed:
card_transaction
object

Informações específicas para transações utilizando o método de pagamento cartão

sub_merchant
object

Dados do cliente que possui o cadastro com a adquirente e está utilizando um facilitador de pagamento.

initiator
object

Indicador de inicialização de transação

first_transaction
object

Dados relacionados a transação original.

string

Identificador do cliente em provedores externos.

int32
1 to 999

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

payee
object

Dados para transações de aporte de recursos.

customer
object

Dados do cliente que está realizando a compra.

items
array of objects

Lista de itens da compra.

items
Headers
string
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)
Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json