cob

txid

String [A-Z0-9-]{26,35}

O campo txid, obrigatório, representa uma cobrança e é único por CPF/CNPJ do usuário recebedor. O objetivo desse campo é ser um elemento que possibilite ao usuário recebedor a funcionalidade de conciliação de pagamentos. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade

calendario

Objeto

Organiza informações a respeito de controle de tempo da cobrança, sua data de criação e expiração

└──expiracao

Int

Representa o tempo de vida da cobrança, especificado em segundos a partir da data de criação

└──criacao

String [date-time]

Representa o momento em que a cobrança foi criada. Exemplo: 2020-09-09T20:15:00.358Z

devedor

Objeto

Identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar o pagamento

└──cpf

String(11 caracteres)

CPF da pessoa física devedora

└──cnpj

String(14 caracteres)

CNPJ da pessoa jurídica devedora

└──nome

String(1-200 caracteres)

Nome da pessoa física ou jurídica devedora

valor

Objeto

Os campos que indicam valores monetários obedecem a especificação onde o separador decimal é o caracter ponto (.), não é aplicável utilizar separador de milhar. Exemplos: “1.00”, “123.99”, “123456789.23”

└──original

String [\d{1,10}.\d{2}]

Representa o valor original total da cobrança

chave

String (1-77 caracteres)

O campo chave, determina a chave Pix registrada no DICT que será utilizada para endereçar a cobrança. Para fins de teste, em ambiente de Sandbox, qualquer chave é válida. A chave (CPF, CPNPJ, eMail, telefone, chave aleatória) pode ser cadastrada na área logada da sua conta PagSeguro, app ou web.

solicitacaopagador

String (1-140 caracteres)

O campo solicitacaoPagador, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor

infoadicionais

Array de objetos

Organiza informações adicionais que, se utilizadas, devem ser apresentadas ao usuário pagador

└──nome

String (1-50 caracteres)

Nome do campo

└──valor

String (1-200 caracteres)

Dados do campo

revisao

Int

Revisão da cobrança, sempre começa em zero e varia em acréscimos de 1 a cada alteração dos dados da cobrança

location

String (77 caracteres)

Representa a localização do payload de cobrança

status

String

Representa o status de uma cobrança:
"ATIVA: Cobrança criada."
"CONCLUIDA: Indica que a cobrança foi paga e não pode aceitar outro pagamento. Importante destacar que o estado CONCLUÍDA refere-se à cobrança gerada e não à liquidação da obrigação em si"
"REMOVIDA_PELO_USUARIO_RECEBEDOR: Cobrança removida pelo requisitante, usuário recebedor."
"REMOVIDA_PELO_PSP: Cobrança removida pela Pagseguro."

pix

Array de objetos

Organiza informações dos recebimentos vinculados à uma cobrança

└──endToEndId

String [A-Z0-9-]{1,35}

ID fim a fim que transita nas mensagens PACS002, PACS004 e PACS008

└──txid

String [A-Z0-9-]{26,35}

O parâmetro, obrigatório, representa o identificador único da cobrança

└──valor

String \d{1,10}.\d{2}

Representa o valor do PIX

└──horario

String [date-time]

Horário em que o Pix foi processado no PSP

└──pagador

Objeto (Pessoa Física ou Pessoa Jurídica)

Representa quem efetivamente quem realizou o pagamento, podendo ser diferente do vendedor. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar o pagamento

└──└──cpf

String(11 caracteres)

CPF da pessoa física devedora

└──└──cnpj

String(14 caracteres)

CNPJ da pessoa jurídica devedora

└──└──nome

String(1-200 caracteres)

Nome da pessoa física ou jurídica devedora

└──└──infopagador

String (1-140) caracteres)

Informações livres do pagador

└──devolucoes

Array de objetos

Organiza informações de devoluções vinculadas à cobrança

└──└──id

String [A-Z0-9-]{1,35}

ID gerado pelo cliente para representar unicamente uma devolução

└──└──rtrid

String (32 caracteres)

ReturnIdentification que transita na PACS004

└──└──valor

String \d{1,10}.\d{2}

Valor a Devolver

└──└──horario

Objeto

Horários em que uma devolução foi solicitada e se aplicável, liquidada

└──└──solicitacao

String [date-time]

Horário no qual a devolução foi solicitada no PSP

└──└──liquidacao

String [date-time]

Horário no qual a devolução foi liquidada no PSP

└──└──status

String

Status da devolução: EM_PROCESSAMENTO, DEVOLVIDO e NAO_REALIZADO

└──└──motivo

String (1-140 caracteres)

Descrição do status da devolução. Exemplos:
REFUND_TRANS_INVALID_REFUND_VALUE_LESS_THAN_ALLOWED
REFUND_TRANS_INVALID_REFUND_VALUE_GREATER_THAN_ALLOWED
REFUND_TRANS_INVALID_INSUFFICIENT_BALANCE
REFUND_TRANS_UNKNOWN_TRANSACTION_EXCEPTION
REFUND_TRANS_PM_UNSUPPORTED
PARTIAL_REFUND_EXCEPTION
REFUND_TRANS_PIN_REPLACEMENT_EXCEPTION