Payload

Definição

O payload é o conteúdo útil transportado por uma mensagem ou operação. O termo delimita qual parte da troca é considerada o conteúdo: em uma API, costuma ser o corpo da mensagem, e em um evento ou fila, é o conjunto de campos que o receptor precisa ler.

{
"pedido": 1042,
"situacao": "pago",
"valor": 299.9,
"forma": "cartao"
}

O payload depende da comunicação

Payload não é um formato específico nem obrigatoriamente JSON. A mesma palavra descreve o conteúdo útil de uma troca HTTP, de um evento ou de uma mensagem em fila, sempre delimitado pelo que aquela comunicação precisa transportar.

Separar payload de metadado

Headers e atributos descrevem a troca, enquanto o payload carrega o conteúdo. Em um aviso de pagamento, o identificador do evento pode estar no metadado e o conteúdo do pagamento no payload.

O que pode falhar e como conferir

A falha mais comum é o payload chegar sem um campo que a integração considera obrigatório. Se a mensagem do pagamento não trouxer o valor, o registro do pedido fica incompleto e a baixa ou o estorno não acontece. Outra falha é ler metadado no lugar do conteúdo, usando o identificador do evento como se fosse o campo de negócio. Para conferir, veja o log da mensagem recebida e compare os campos presentes com os que a integração espera ler. A diferença entre o que chegou e o que deveria chegar indica onde o processo quebrou.

Aplicação na formação

Vibe Coding: Do Zero ao MVP

Na Formação Vibe Coding, o payload carrega os campos de negócio que a integração precisa ler.

Conhecer a formação →