/charges
Consulta (sonda) de Charges.
É obrigatório que ao menos um dos dois parâmetros de identificação da cobrança seja informado (ids ou initiator_ids).
Se os dois forem informados, será usado o identificador da charge.
A autenticação no endpoint é feita da seguinte forma:
- Bearer Token Authorization: Token JWT.
get
https://payments.stone.com.br/v1/charges
Query Parameters
idsarray[string]required
Identificador(es) da(s) charge(s). Obrigatório caso não haja o parâmetro initiator_ids
initiator_idsarray[string]required
Identificador(es) externo(s). Obrigatório caso não haja o parâmetro ids
with_detailsstring(boolean)
Informa se serão exibidas informações detalhadas das operações realizadas na charge. Valor padrão é false.
Allowed values:true
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 produtivosdx-payments.stone.com.br: ambiente de sandbox (pré-produção)
Response
application/json
Response
application/json
OK
GetChargeResponse
chargesarray[object]
Show Child Parameters
get/charges
Authentication
Query Parameters
Headers
application/json
/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 produtivosdx-payments.stone.com.br: ambiente de sandbox (pré-produção)
Body
application/json
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
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
Authentication
Path Parameters
Headers
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 produtivosdx-payments.stone.com.br: ambiente de sandbox (pré-produção)
Body
application/json
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
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
Authentication
Headers
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 produtivosdx-payments.stone.com.br: ambiente de sandbox (pré-produção)
Response
200 text/plain
Response
200 text/plain
OK
get/health_check/live
Headers
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 produtivosdx-payments.stone.com.br: ambiente de sandbox (pré-produção)
Response
application/json
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
Headers
application/json