Stone Online · API (Legado)

/health_check/ready

Endpoint para checagem da disponibilidade das dependências internas (EventBus e Adquirência) da aplicação.

get
https://payments.stone.com.br/v1/health_check/ready

Headers

Hoststringrequired

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)

Response

application/json

OK

HealthCheckReadyResponse

statusstring

Status do serviçamento

Allowed values:HealthyDegradedUnhealthy

durationstring(HH:mm:ss.ms)

Duração na checagem

infoarray[object]
Show Child Parameters
get/health_check/ready
 
application/json

/cards/verify

Validação de um novo cartão.

A autenticação no endpoint é feita da seguinte forma:

  • Bearer Token Authorization: Token JWT.
post
https://payments.stone.com.br/v1/cards/verify

Headers

Hoststringrequired

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)

Body

application/json

PostCardsVerifyRequest

typestringrequired

Tipo de cartão está sendo utilizado na cobrança.

Allowed values:creditdebitvoucher

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.

initiator_idstringrequired

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.

statement_descriptorstring

Informação adicional apresentada na filipeta para o comprador final. Em geral o nome fantasia do cliente.

merchant_category_codestring

Código de categoria do lojista ou sublojista relacionado à cobrança.

cardobjectrequired
Show Child Parameters

Response

application/json

OK

PostCardsVerifyResponse

idstringrequired

Identificador único da validação.

initiator_idstringrequired

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.

statusstringrequired

Status atual da validação

Allowed values:authorizeddeclined

resultstringrequired

Resultado da operação de validação

Allowed values:successfailed

created_atstring(yyyy-MM-ddTHH:mm:ssZ)required

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

transaction_idstringrequired

Identificador da transação emitido pelo provedor (Adquirente).

operation_idstring

Identificador da operação gerado pela adquirente.

authorization_codestring

Código de autorização.

>= 6 characters<= 6 characters

acquirer_messagestring

Mensagem de resultado da operação retornada pela adquirente.

acquirer_return_codestringrequired

Código de resultado da operação retornado pela adquirente.

>= 2 characters<= 4 characters

cardobjectrequired
Show Child Parameters
post/cards/verify

Body

{ "type": "credit", "initiator_id": "b4d67123a94c4c77", "local_datetime": "2023-07-15T10:53:16", "reference_id": "or_3f4783edd45", "card": { "number": "4705980000007171", "expiration_date": "2608", "cvv": "111", "holder_name": "TONY STARK" } }
 
application/json

PostChargeRequest

object
payment_methodstringrequired

Payment method da charge

Allowed values:card

amountinteger(int64)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).

>= 3 characters<= 3 characters

initiator_idstringrequired

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

<= 123 characters

reference_idstring

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

<= 128 characters

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.

channelstring

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 values:standalone_devicestandalone_mobilewebsiteapppayment_link

card_transactionobject

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

Show Child Parameters
sub_merchantobject

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

Show Child Parameters
initiatorobject

Indicador de inicialização de transação

Show Child Parameters
first_transactionobject

Dados relacionados a transação original.

Show Child Parameters
partner_platform_idstring

Identificador do cliente em provedores externos.

print_line_sizeinteger(int32)

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

>= 1<= 999

payeeobject

Dados para transações de aporte de recursos.

Show Child Parameters
customerobject

Dados do cliente que está realizando a compra.

Show Child Parameters
itemsarray[object]

Lista de itens da compra.

Show Child Parameters
Example

PostChargeResponse

object
idstringrequired

Identificador único da cobrança.

initiator_idstringrequired

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(int64)required

Valor requisitado na cobrança em centavos.

payment_methodstringrequired

Meio de pagamento da cobrança.

Allowed values:card

statusstringrequired

Status atual da Charge

Allowed values:authorizedpaidcanceleddeclined

created_atstring(yyyy-MM-ddTHH:mm:ssZ)required

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

card_transactionobject
Show Child Parameters
Example

PostChargeCaptureRequest

object
amountinteger(int64)required

Valor a ser capturado

>= 1

emv_datastring

Dados obtidos do chip do cartão

initiator_operation_idstring

Identificador externo que pode ser utilizado para identificar cada operação realizada

Example