v1

latestOpenAPI 3.0.32026-07-265974.7 KB
Charges

Captura de uma charge autorizada.<br><br> A autenticação no endpoint é feita da seguinte forma:

  • Bearer Token Authorization: Token JWT.
post/charges/{id}/capture

Path parameters

idstring required

Identificador da charge retornado em sua criação

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

amountinteger required

Valor a ser capturado

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

OK

idstring required

Identificador único da cobrança.

initiator_idstring required

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 required

Valor requisitado na cobrança em centavos.

payment_method'card' required

Meio de pagamento da cobrança.

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

Status atual da Charge

created_atstring yyyy-MM-ddTHH:mm:ssZ required

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