Stone Online · API (Legado)

Charges

/charges

Criação de uma nova cobrança.

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

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

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

PostChargeRequest

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

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

Body

{ "amount": 923, "initiator_id": "1470375860-3.19.3.3-RG0DA3-0001", "local_datetime": "2023-07-15T10:53:16", "payment_method": "card", "card_transaction": { "type": "credit", "operation_type": "auth_and_capture", "installments": 3, "installments_type": "merchant", "statement_descriptor": "loja teste", "card": { "entry_mode": "magstripe", "expiration_date": "2608", "number": "4705980000007171", "cvv": "111", "holder_name": "TONY STARK" }, "authentication": { "type": "offline_pin" } } }
 
application/json

/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 produtivo
  • sdx-payments.stone.com.br: ambiente de sandbox (pré-produção)

Response

application/json

OK

GetChargeResponse

chargesarray[object]
Show Child Parameters
get/charges
 
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 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