Stone Online · API (Legado)

/charges/{id}/capture

Captura de uma charge autorizada.

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

  • Bearer Token Authorization: Token JWT.
post
https://payments.stone.com.br/v1/charges/{id}/capture

Path Parameters

idstringrequired

Identificador da charge retornado em sua criação

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

PostChargeCaptureRequest

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

Response

application/json

OK

PostChargeResponse

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
post/charges/{id}/capture

Body

{ "amount": 923 }
 
application/json

/charges/cancel

Reversão ou Cancelamento de uma charge.
Pode ser utilizado o id ou o initiator_id.
Se os dois forem informados, será usado o id.

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

  • Bearer Token Authorization: Token JWT.
post
https://payments.stone.com.br/v1/charges/cancel

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

PostChargeCancelRequest

idstring

Identificador da charge. Obrigatório se não for informado o initiator_id

initiator_idstring

Identificador externo que pode ser utilizado em reversões. Obrigatório se não for informado o id

amountinteger(int64)required

Valor a ser revertido (valor da autorização)

>= 1

reasonstring

Motivo da solicitação do cancelamento

initiator_operation_idstring

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

card_transactionobject

Informações específicas para cancelamentos de transações utilizando o método de pagamento cartão. Este nó é obrigatório apenas para transações da bandeira Banricompras com cartão presente. Caso contrário, deve ser omitido

Show Child Parameters

Response

application/json

OK

PostChargeCancelResponse

idstringrequired

Identificador da charge

amountinteger(int64)required

Valor estornado/revertido em centavos

payment_methodstringrequired

Payment method da charge

Allowed values:card

statusstringrequired

Status atual da Charge

Allowed values:authorizedpaidcanceleddeclined

card_transactionobject
Show Child Parameters
post/charges/cancel

Body

{ "initiator_id": "b4d67123a94c4c77", "amount": 100, "reason": "4001" }
 
application/json

/health_check/live

Endpoint para checagem de disponibilidade da aplicação.

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

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

200 text/plain

OK

get/health_check/live
 
200 text/plain

/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