PostChargeRequest
objectpayment_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
Example
PostChargeResponse
objectidstringrequired
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
Example
PostChargeCaptureRequest
objectamountinteger(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
Example
PostChargeCaptureResponse
objectidstringrequired
Identificador da charge
amountinteger(int64)required
Valor capturado 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
PostChargeCancelByIdRequest
objectamountinteger(int64)required
Valor a ser estornado
>= 1
reasonstring
Código do 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