Sign in

v1

latestOpenAPI 3.0.32026-07-265974.7 KB
Charges

Reversão ou Cancelamento de uma charge.<br> Pode ser utilizado o id ou o initiator_id.<br> Se os dois forem informados, será usado o id.<br><br> A autenticação no endpoint é feita da seguinte forma:

  • Bearer Token Authorization: Token JWT.
post/charges/cancel

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

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 required

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

reasonstring

Motivo da solicitação do cancelamento

initiator_operation_idstring

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

Example request

{
  "card_transaction": {
    "authentication": {
      "online_pin": {
        "ksi": "20141125FF",
        "pin_block": "1C89680698D29991"
      }
    }
  }
}

Response

OK

idstring required

Identificador da charge

amountinteger required

Valor estornado/revertido em centavos

payment_method'card' required

Payment method da charge

status'authorized' | 'paid' | 'canceled' | 'declined' required

Status atual da Charge