PostChargeCancelRequest
objectidstring
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
Example
PostChargeCancelResponse
objectidstringrequired
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
Example
GetChargeResponse
objectchargesarray[object]
Show Child Parameters
Example
PostCardsVerifyRequest
objecttypestringrequired
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
Example
PostCardsVerifyResponse
objectidstringrequired
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
Example