Este objeto é responsável por apresentar todos os dados disponíveis em uma cobrança, ou seja, na iniciação de um pagamento.
Atributos
id String (41 caracteres)
Identificador da cobrança PagBank.
Exemplo: CHAR_67FC568B-00D8-431D-B2E7-755E3E6C66A0
status String (1-64 caracteres)
Status da cobrança.
AUTHORIZED indica que a cobrança está pré-autorizada.PAID indica que a cobrança está paga (capturada).IN_ANALYSIS indica que o comprador optou por pagar com um Cartão de Crédito e o PagBank está
analisando o risco da transação.DECLINED Indica que a cobrança foi negada pelo PagBank ou Emissor.CANCELED indica que a cobrança foi cancelada.WAITING Indica que a cobrança está aguardando pagamento.
created_at Datetime
Data e horário em que foi criada a cobrança.
Exemplo: 2023-02-08T15:15:11.881-03:00
paid_at Datetime
Data e horário em que a cobrança foi paga (capturada).
Exemplo: 2023-02-08T15:15:12.000-03:00
reference_id String (1-64 caracteres)
Identificador único atribuído para a cobrança.
Exemplo: Referência da cobrança
description String (1-64 caracteres)
Descrição da cobrança.
Exemplo: Descrição da cobrança
amount Object
Contém as informações do valor a ser cobrado.
value Int (9 caracteres)
Valor a ser cobrado em centavos. Apenas números inteiros positivos.
Exemplo: R$ 1.500,99 = 150099
currency String (3 caracteres)
Código de moeda ISO de três letras, em maiúsculas. Por enquanto, apenas o Real brasileiro é suportado
(“BRL”).
Exemplo: BRL
summary Object
Contém um resumo de valores da cobrança.
total Int (9 caracteres)
Valor total da cobrança.
Exemplo: 150099
paid Int (9 caracteres)
Valor que foi pago na cobrança.
Exemplo: 150099
refunded Int (9 caracteres)
Valor que foi devolvido da Cobrança.
Exemplo: 0
payment_response Object
Contém informações de resposta do provedor de pagamento.
code Int (5 caracteres)
Código PagBank que indica o motivo da resposta de autorização no pagamento, tanto para pagamento
autorizado, quanto para negado.
Exemplo: 20000
message String (5-100 caracteres)
Mensagem amigável descrevendo motivo da não aprovação ou autorização da cobrança. Compatível com o
padrão ABECS - Normativo 21.
Exemplo: SUCESSO
reference String (4-20 caracteres)
NSU da autorização, caso o pagamento seja aprovado pelo Emissor.
Exemplo: 032416400102
raw_data Object
Contém informações puras vindas dos emissores/bandeiras
authorization_code Int (6 caracteres)
Código de autorização gerado no momento da tentativa de autorização da transação.
Exemplo: 308654
nsu String (4-20 caracteres)
Código identificador único gerado para transações de crédito e débito, nesses dois cenários será o
mesmo valor enviado no campo payment_responde.reference
Exemplo: 032416400102
reason_code String (2 caracteres)
Código de retorno enviado pela bandeira/emissor sem sofrer normatizações por parte do Pagbank,
possibilitando assim análises junto da bandeira pelas negativas da transação.
Exemplo: 70
merchant_advice_code String (2 caracteres)
Código complementar ao reason_code (exclusivo atualmente para a Mastercard)
Exemplo: 80
payment_method Object
Contém as informações do método de pagamento da cobrança.
type ENUM
Indica o método de pagamento usado na cobrança.
Valores de ENUM:
CREDIT_CARD ou DEBIT_CARD se o método de pagamento utilizado for Cartão de
Crédito, Cartão de Débito ou Token de Bandeira. ⚠️ Obrigatório o envio do objeto
payment_method.card. ⚠️
BOLETO se o método de pagamento utilizado for Boleto. ⚠️ Obrigatório o envio do objeto
payment_method.boleto. ⚠️
installments Int (2 caracteres)
Quantidade de parcelas. ⚠️ Obrigatório para o método de pagamento
Cartão de Crédito. ⚠️
Exemplo: 06
capture Boolean
Parâmetro que indica se uma transação de Cartão de Crédito deve ser apenas pré-autorizada (reserva o
valor da cobrança no cartão do cliente de 6 á 29 dias) ou se a transação deve ser capturada automaticamente
(cobrança realizada em apenas um passo). ⚠️ Obrigatório para o método de pagamento
Cartão de Crédito. Função indisponível para o método de pagamento Cartão de Débito e Token de Bandeira
(débito). ⚠️
VISA, MASTERCARD, AMEX,
ELO.
VISA, MASTERCARD,
ELO.
Informar true para cobrança em único passo. Informar false para
pré-autorizar.
capture_before Datetime
Data e horário limite para que seja feita a captura em uma transação com o status
AUTHORIZED.
Exemplo: 2023-02-18T15:15:11.881-03:00
MASTERCARD,VISA e ELO permitirá à captura em até 29 dias para
MCCs permitidos pelas bandeiras. Lista de
MCCs disponíveis. Demais bandeiras permitirá à captura em até 6 dias.
soft_descriptor String (0-22 caracteres)
Parâmetro responsável pelo que será exibido como Nome na Fatura do cliente. ⚠️
Aplicável no momento apenas para Cartão de crédito. Não permite caracteres especiais (acentuações serão
substituídas por caracteres sem acentos, demais caracteres especiais serão removidos). ⚠️
Exemplo: IntegraçãoPagBank
card Object
Contém os dados de Cartão de Crédito, Cartão de Débito e Token de Bandeira. ⚠️ Obrigatório para o método de
pagamento Cartão de Crédito, Cartão de Débito e Token de Bandeira. ⚠️
id String (41 caracteres)
Identificador PagBank do Cartão de Crédito salvo (Cartão Tokenizado pelo PagBank). ⚠️ Função indisponível para o método
de pagamento Cartão de Débito e Token de Bandeira. ⚠️
Exemplo: CARD_CCFE8D12-79E9-4ADF-920B-A54E51D8DA6E
number String (14-19 caracteres)
Número do Cartão de Crédito ou Cartão de Débito.
Exemplo: 4111111111111111
network_token String (14-19 caracteres)
Número do Token de Bandeira.
Exemplo: 1234567890000000
exp_month Int (1/2 caracteres)
Mês de expiração do Cartão de Crédito, Cartão de Débito ou Token de Bandeira.
Exemplo: 12
exp_year Int (3/4 caracteres)
Ano de expiração do Cartão de Crédito, Cartão de Débito ou Token de Bandeira.
Exemplo: 2026
security_code String (3/4 caracteres)
Código de Segurança do Cartão de Crédito, Cartão de Débito ou Token de Bandeira.
Exemplo: 2026
store Boolean
Indica se o cartão deverá ser armazenado no PagBank para futuras compras. ⚠️ Função indisponível para o método
de pagamento Cartão de Débito e Token de Bandeira. ⚠️
Informar false ou omitir este parâmetro fará com que o cartão não seja
armazenado. Informar true fará com que o cartão seja armazenado. Na resposta da requisição
irá receber o token do cartão em payment_method.card.id.
brand String (20 caracteres)
Bandeira do cartão.
Exemplo: visa
product String (20 caracteres)
Retornado quando um Cartão de Crédito foi do tipo PRE_PAID.
Exemplo:
first_digits Int (6 caracteres)
payment_instructions Object
Contém as instruções de pagamento, incluindo regras de multa, juros e descontos.
fine Object
Define as regras de aplicação de multa por atraso.
date String (10 caracteres)
Data a partir da qual a multa é aplicada. Formato: YYYY-MM-DD.
Exemplo: 2023-02-10
value Int (9 caracteres)
Valor percentual da multa a ser cobrada. O valor deve ser enviado em centavos de porcentagem
(ex: 2% = 200). Apenas números inteiros positivos.
Exemplo: 200
interest Object
Define as regras de aplicação de juros por atraso.
date String (10 caracteres)
Data a partir da qual os juros são aplicados. Formato: YYYY-MM-DD.
Exemplo: 2023-02-10
value Int (9 caracteres)
Valor percentual dos juros a ser cobrado. O valor deve ser enviado em centavos de porcentagem
(ex: 2% = 200). Apenas números inteiros positivos.
Exemplo: 200
discounts Object
Define as regras de desconto por pagamento antecipado.
date String (10 caracteres)
Data limite para a aplicação do desconto (pagamento deve ocorrer até esta data). Formato:
YYYY-MM-DD.
Exemplo: 2023-02-10
value Int (9 caracteres)
Valor percentual do desconto a ser aplicado. O valor deve ser enviado em centavos de
porcentagem (ex: 2% = 200). Apenas números inteiros positivos.
Exemplo: 200
qr_codes Array of Object
Objeto contendo os QR Codes vinculados à um pedido. Ao informar o amount, o QR code será gerado
automaticamente e pode ser pago com aplicativos de outras instituições (Pix). ⚠️
Para que o QR Code aceite o pagamento Pix, o vendedor precisa ter pelo menos uma chave de endereçamento ativa
vinculada a sua conta PagBank. ⚠️ Caso o vendedor tenha mais de uma chave de
endereçamento cadastrada no PagBank, priorizaremos a utilização da chave de endereçamento aleatória.
amount, o QR code será gerado
automaticamente e pode ser pago com aplicativos de outras instituições (Pix). ⚠️
Para que o QR Code aceite o pagamento Pix, o vendedor precisa ter pelo menos uma chave de endereçamento ativa
vinculada a sua conta PagBank. ⚠️ Caso o vendedor tenha mais de uma chave de
endereçamento cadastrada no PagBank, priorizaremos a utilização da chave de endereçamento aleatória.expiration_date Datetime
Data de expiração do QR Code. Por padrão, o QR Code gerado tem validade até as 23h59m do dia seguinte
caso
o parâmetro qr_codes.expiration_date não seja definido na requisição.
Exemplo: 2021-08-29T20:15:59-03:00
amount Object
Contém informações do valor a ser utilizado no QR Code.
value Int (5 caracteres)
Valor do QR Code.
Exemplo: 500