charge

O objeto charge é responsável por representar todos os dados disponíveis em uma cobrança, ou seja na iniciação de um pagamento.

Descrição

Campo

Tipo

Descrição

id

String (41 caracteres)

Identificador da cobrança PagSeguro

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).
  • DECLINED : Indica que a cobrança foi negada pelo PagSeguro ou Emissor.
  • CANCELED : Indica que a cobrança foi cancelada.

created_at

Datetime

Data e horário em que foi criada a cobrança.

paid_at

Datetime

Data e horário em que a cobrança foi paga (capturada).

reference_id

String (1-64 caracteres)

Identificador próprio atribuído para a cobrança.

description

String (1-64 caracteres)

Descrição da cobrança.

amount

Object

Objeto contendo 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”)

summary

Object

Objeto contendo um resumo de valores da cobrança.

↳↳total

Int (9 caracteres)

Valor total da cobrança.

↳↳paid

Int (9 caracteres)

Valor que foi pago na Cobrança

↳↳refunded

Int (9 caracteres)

Valor que foi devolvido da Cobrança

payment_response

Object

Objeto contendo informações de Resposta do Provedor de Pagamento.

code

Int (5 caracteres)

Código PagSeguro que indica o motivo da resposta de autorização no pagamento, tanto para pagamento autorizado, quando para negada.
Veja a lista com detalhamento dos códigos aqui.

message

String (5-100 caracteres)

Mensagem amigável descrevendo motivo da não aprovação ou autorização da cobrança.
Compatível com padrão ABECS - Normativo 21.

reference

String (4-20 caracteres)

NSU da autorização, caso o pagamento seja aprovado pelo Emissor.

payment_method

Object

Objeto contendo as informações do método de pagamento da cobrança

type

String (ENUM)

Indica o método de pagamento usado na cobrança.

  • 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 rede, será obrigatório o envio do objeto payment_method.card.
  • BOLETO Se o método de pagamento utilizado for boleto bancário, será 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.

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 por até 5 dias) ou se a transação deve ser capturada automaticamente (cobrança realizada em apenas um passo).

  • Informar false para pré-autorizar
  • Ou true para cobrança em 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 rede (débito).
    Bandeiras de cartão de crédito:
  • VISA
  • MASTERCARD
  • AMEX
  • ELO
    Bandeiras de token de rede (crédito):
  • VISA
  • MASTERCARD
  • ELO

soft_descriptor

String (0-17 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)

card

Object

Objeto contendo os dados de cartão de crédito, cartão de débito ou token de rede. Obrigatório para o método de pagamento com cartão ou token de rede.

↳↳id

String (41 caracteres)

Identificador PagSeguro do cartão de crédito salvo (Cartão Tokenizado pelo PagSeguro). Função indisponível para o método de pagamento cartão de débito e token de rede.

↳↳number

String (14-19 caracteres)

Número do cartão de crédito ou cartão de débito.

↳↳network_token

String (14-19 caracteres)

Número do token de rede.

↳↳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 rede.

↳↳exp_year

Int (2/4 caracteres)

Ano de expiração do cartão de crédito, cartão de débito ou token de rede.

↳↳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 rede.

↳↳store

Boolean

Indica se o cartão deverá ser armazenado no PagSeguro para futuras compras.

  • Se informar false ou omitir esse parâmetros não será armazenado.
  • Informe true para que seja armazenado, na resposta da requisição você terá o token do cartão em payment_method.card.id. Função indisponível para o método de pagamento cartão de débito e token de rede.

↳↳brand

String (20 caracteres)

Bandeiras de cartão de crédito:

  • VISA
  • MASTERCARD
  • AMEX
  • ELO
  • HIPERCARD
  • HIPER
  • DINERS
    Bandeiras de cartão de débito:
  • VISA
  • MASTERCARD
  • ELO
    Bandeiras de token de rede:
  • VISA
  • MASTERCARD
  • ELO

↳↳first_digits

Int (6 caracteres)

Seis primeiros números do cartão ou token de rede (BIN).

↳↳last_digits

Int (4 caracteres)

Quatro últimos números do cartão ou token de rede.

↳↳holder

Object

Objeto contendo as informações do portador do cartão de crédito, cartão de débito e token de rede.

↳↳↳name

String (1-30 caracteres)

Nome do portador do cartão de crédito, cartão de débito e token de rede.

↳↳↳tax_id

String (11/14 caracteres)

Número do documento do portador do cartão de crédito, cartão de débito e token de rede.

token_data

Object

Objeto contendo os dados adicionais de Tokenização de Rede. Deve ser enviado quando um cartão de crédito ou débito tokenizado pelas bandeiras Visa ou Mastercard é utilizado.

↳↳requestor_id

String(11)

Identificador de quem gerou o token de rede (Token Requestor).

↳↳wallet

String (ENUM)

Tipo de carteira que armazenou o token de rede.

  • APPLE_PAY
  • GOOGLE_PAY
  • SAMSUNG_PAY
  • MERCHANT_TOKENIZATION_PROGRAM

↳↳cryptogram

String(40)

Criptograma gerado pela bandeira.

↳↳ecommerce_domain

String(150)

Identificador do domínio de origem da transação, comumente caracterizado em um formato de domínio reverso. Ex: br.com.pagseguro

↳↳assurance_level

Int(2)

Conteúdo que indica o nível de confiança do token de rede.

authentication_method

Object

Objeto contendo os dados adicionais de autenticação vinculados à uma transação. Obrigatório quando payment_method.type = DEBIT_CARD

↳↳type

String(ENUM)

Indica o método de autenticação utilizado na cobrança.

  • THREEDS: Se o método de autenticação utilizado for 3DS.
  • INAPP : Se o método de autenticação utilizado for InApp. Condicional para Token de Rede ELO.

↳↳cavv

String(80)

Identificador único gerado em cenário de sucesso de autenticação do cliente.

↳↳eci

String (2)

E-Commerce indicator retornado quando ocorre uma autenticação. Corresponde ao resultado da autenticação.

↳↳xid

String(80)

Identificador de uma transação de um MPI. Recomendado para a bandeira VISA. Condicional para 3DS.

↳↳version

String(10)

Versão do protocolo 3DS utilizado na autenticação.

  • 2.0.1
  • 2.2.0
  • 1.0.2

↳↳dstrans_id

String(80)

ID da transação gerada pelo servidor de diretório durante uma autenticação. Recomendado para a bandeira Mastercard. Condicional para 3DS.

↳↳status

String(80)

Status de uma autenticação 3DS.

  • AUTHENTICATED
  • NOT AUTHENTICATED

boleto

Object

Objeto contendo os dados para geração do boleto

↳↳due_date

String (10 caracteres)

Data de vencimento do boleto. Formato: “yyyy-MM-dd”

↳↳instruction_lines

Object

Objeto contendo as linhas de instrução do boleto

↳↳↳line_1

String (1-75 caracteres)

Primeira linha de instruções sobre o pagamento do boleto.

↳↳↳line_2

String (1-75 caracteres)

Segunda linha de instruções sobre o pagamento do boleto.

↳↳holder

Object

Objeto contendo as informações do responsável pelo pagamento do boleto

↳↳↳name

String (1-30 caracteres)

Nome do responsável pelo pagamento do boleto.

↳↳↳tax_id

String (11/14 caracteres)

Número do documento do responsável pelo pagamento do boleto.

↳↳↳email

String (10-255 caracteres)

E-mail do responsável pelo pagamento do boleto.

↳↳↳address

Object

Objeto Address

recurring

Object

Objeto contendo as informações da recorrência. Os clientes que possuem recorrência própria devem utilizar esse parâmetro para indicar ao PagSeguro que a cobrança está relacionada a um pagamento recorrente. A utilização desse parâmetro não está vinculada à API de Pagamento Recorrente do PagSeguro.

type

String (ENUM)

Indica se a cobrança é proveniente de uma recorrência.

  • INITIAL : Para a primeira cobrança da recorrência.
  • SUBSEQUENT : Para as cobranças subsequentes.

sub_merchant

Objeto

Objeto sub_merchant contendo os dados do sub lojista, usado por sub-adquirentes para transações com cartão de crédito. Usado apenas por sub-adquirentes autorizados.

notification_urls

Array of String

URLs que serão notificadas em toda alteração ocorrida na cobrança.

  • Necessário que seja em ambiente seguro com SSL(HTTPS).

metadata

Map

Conjunto de pares de valores-chave que você pode anexar a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado

links

Array of Object

Objeto link contendo as informações de links relacionado ao recurso.