Dias MarketPlace
  • Começando
    • Início
    • Tokenização do Cartão
    • SDK de 3DS
    • Integre com IA
  • Formato dos Webhooks
    • Pagamento
    • Transferência
    • Recorrência
    • Carrinho Abandonado
  • Loja
    • Consultar Saldo
      GET
    • Consultar Informações
      GET
  • Pagamentos
    • Criar Pagamento
      POST
    • Buscar Pagamento
      GET
    • Estornar Pagamento
      POST
  • Transferência
    • Criar Transferência
      POST
    • Buscar Transferência
      GET
  • Recorrência
    • Criar Recorrência
      POST
    • Buscar Recorrência
      GET
    • Cancelar Recorrência
      POST
  • Checkout
    • Integração Shopify
    • Integração WooCommerce
  • Links de Pagamento
    • Criar Smart Link
      POST
    • Editar Smart Link
      PUT
Dias MarketPlace2026

Webhooks - Pagamentos

Esta página descreve o formato do webhook enviado pela plataforma sempre que houver uma atualização no status de um pagamento.

Descrição

O webhook de pagamento é enviado automaticamente sempre que o status do pagamento for alterado, permitindo que o sistema do integrador mantenha suas informações sincronizadas em tempo real.

As notificações são enviadas via requisições HTTP no método POST, utilizando o formato JSON.

Padrão de Timezone

Todos os campos de data e hora enviados nos webhooks utilizam o padrão ISO 8601 no timezone UTC (UTC+00:00), garantindo consistência independentemente do fuso horário do integrador. Para evitar divergências causadas por horários locais ou horário de verão, recomenda-se manter os valores em UTC para armazenamento e processamento, realizando a conversão para o fuso horário local apenas no nível de apresentação ao usuário final.

Evento e Reentrega

Toda notificação traz o header X-Webhook-Event, com o evento que motivou o envio. Use este header para decidir o que fazer com a notificação: o mesmo evento pode chegar com mais de um status no corpo.

Nesta página, o X-Webhook-Event pode trazer:

  • payment.created – Pagamento criado. O corpo traz o status da criação, normalmente PENDING ou PROCESSING.
  • payment.paid – Pagamento confirmado, com status PAID.
  • payment.refused – Pagamento recusado, com status REFUSED.
  • payment.refunded – Pagamento estornado ou contestado, com status REFUNDED, MED ou CHARGEDBACK.

O recebimento é confirmado quando o seu endpoint responde com HTTP 2xx em até 30 segundos. Fora disso, a plataforma tenta de novo, até 6 tentativas no total: 1 minuto, 10 minutos, 1 hora, 6 horas e 11 horas depois da tentativa anterior.

As respostas 404, 405 e 410 encerram as tentativas na hora, porque indicam que a URL não existe ou não aceita a notificação. Como a mesma notificação pode chegar mais de uma vez, processe o recebimento de forma idempotente.

Validação Opcional do Webhook

Para aumentar a segurança, os webhooks cadastrados diretamente no painel podem incluir uma assinatura enviada no header X-Signature: <assinatura-em-base64>, permitindo validar a autenticidade da notificação recebida. Essa assinatura é gerada pela plataforma utilizando HMAC com SHA-256 sobre o corpo do webhook, em formato JSON, usando um segredo compartilhado WEBHOOK_SECRET e codificada em Base64. O integrador pode reproduzir o mesmo cálculo em seu sistema utilizando o mesmo segredo e o payload recebido. Se a assinatura gerada for igual à enviada no header, o webhook é considerado legítimo e íntegro. Caso sejam diferentes, a requisição pode ter sido alterada ou não ter sido enviada pela plataforma.

Essa validação está disponível apenas para webhooks cadastrados no painel. Webhooks enviados para uma URL informada dinamicamente via notificationUrl não incluem a assinatura X-Signature.

A validação por assinatura é opcional, porém fortemente recomendada sempre que o webhook for configurado pelo painel, para garantir maior segurança na comunicação.

Endpoint de Notificação

A URL de notificação deve ser informada no momento da criação do pagamento, através do campo <code>notificationUrl</code>.

O endpoint deve estar acessível publicamente e responder com HTTP 200 para confirmar o recebimento do webhook.

Além disso, as notificações de pagamento também podem ocorrer via webhook in-bound, configurado diretamente no painel do gateway. Nesse modelo, o endpoint é previamente cadastrado e será acionado automaticamente a cada mudança de status do pagamento.

Status do Pagamento

Os possíveis valores para o campo status são:

  • PENDING – Pagamento criado e aguardando confirmação.
  • PROCESSING – Pagamento em processamento ou em análise.
  • PAID – Pagamento confirmado com sucesso.
  • REFUSED – Pagamento recusado pelo emissor ou sistema antifraude.
  • REFUNDED – Pagamento estornado (valor total).
  • MED – Contestação em análise preliminar, aguardando evidências.
  • CHARGEDBACK – Contestação confirmada com reversão do pagamento.

Formato do Payload

Abaixo estão exemplos de payload enviados no webhook de acordo com o meio de pagamento.

No cartão, o data.card3DSToken só vem na resposta da criação do pagamento, enquanto a autenticação 3DS está pendente. Ele nunca é enviado no webhook.

JSON
{
  "id": "cm6p1x8k70001ls08h2q9d3vz",
  "amount": 10000,
  "method": "PIX",
  "currency": "BRL",
  "status": "PAID",
  "description": "Pagamento de teste via PIX",
  "installments": 1,
  "discount": null,
  "payer": {
    "name": "John Doe",
    "taxId": "12345678909",
    "email": "john.doe@example.com",
    "phone": "+5511999990000"
  },
  "items": [
    {
      "quantity": 1,
      "name": "Produto Teste",
      "price": 8500,
      "type": "PHYSICAL"
    }
  ],
  "delivery": {
    "fee": 1500,
    "tracking": {
      "type": "SEDEX",
      "code": null,
      "url": null,
      "status": "WAITING"
    },
    "address": {
      "zipCode": "01001-000",
      "country": "BR",
      "state": "SP",
      "city": "São Paulo",
      "neighborhood": "Centro",
      "line1": "Rua Exemplo",
      "line2": "Apto 45",
      "streetNumber": "123"
    }
  },
  "data": {
    "method": "PIX",
    "copypaste": "00020101021226850014br.gov.bcb.pix2563api.gateway.test/pix/123e4567-e89b-12d3-a456-4266141740005204000053039865802BR5920GATEWAY TESTE6009SaoPaulo61080540900062070503***6304ABCD",
    "e2e": "E1234567890123456789012345678901"
  },
  "splits": [
    {
      "index": 1,
      "amount": 10000,
      "currency": "BRL",
      "percent": 100,
      "fixed": 0,
      "shareFees": true,
      "storeId": "cm5t0a9qz0000ls08p4r7c2kd",
      "splitId": null
    }
  ],
  "fees": {
    "amount": 199,
    "payFeeAmount": 199,
    "chkFeeAmount": 0,
    "memFeeAmount": 0
  },
  "utms": {
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "black-friday-2026",
    "utmContent": "banner-topo",
    "utmTerm": "tenis-de-corrida",
    "src": "blog-artigo-1",
    "sck": "lista-quente"
  },
  "orderId": null,
  "recrInvoiceId": null,
  "externalRef": "order_123456",
  "notificationUrl": "https://example-webhook.test/notifications",
  "metadata": null,
  "paidAt": "2026-01-15T16:51:42.782Z",
  "refundedAt": null,
  "createdAt": "2026-01-15T13:44:25.838Z",
  "updatedAt": "2026-01-15T16:51:42.782Z"
}
JSON
{
  "id": "cm6p1yk3d0007ls08r5w8j1uc",
  "amount": 2500,
  "method": "CREDIT_CARD",
  "currency": "BRL",
  "status": "PROCESSING",
  "description": "Compra de produto de teste",
  "installments": 3,
  "discount": null,
  "payer": {
    "name": "John Doe",
    "taxId": "12345678909",
    "email": "john.doe@example.com",
    "phone": "+5511999990000"
  },
  "items": [
    {
      "quantity": 1,
      "name": "Produto Teste",
      "price": 1000,
      "type": "PHYSICAL"
    }
  ],
  "delivery": {
    "fee": 1500,
    "tracking": {
      "type": "PAC",
      "code": null,
      "url": null,
      "status": "WAITING"
    },
    "address": {
      "zipCode": "01001-000",
      "country": "BR",
      "state": "SP",
      "city": "São Paulo",
      "neighborhood": "Centro",
      "line1": "Rua Exemplo",
      "line2": "Apto 45",
      "streetNumber": "123"
    }
  },
  "data": {
    "method": "CREDIT_CARD",
    "message": "Autenticação 3DS pendente",
    "redirectUrl": "https://3ds.example.test/challenge/cm6p1yk3d0007ls08r5w8j1uc",
    "cardHolder": "JOHN DOE",
    "cardNumber": "411111******1111",
    "cardExpMonth": "12",
    "cardExpYear": "2028",
    "cardChargeInterest": false,
    "card3DS": {
      "id": "3ds_8f2k1m9q4w7z",
      "token": "3ds_session_5b7c9d1e3f"
    },
    "card3DSToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXltZW50SWQiOiJjbTZwMXlrM2QwMDA3bHMwOHI1dzhqMXVjIn0.c2lnbmF0dXJl"
  },
  "splits": [
    {
      "index": 1,
      "amount": 2500,
      "currency": "BRL",
      "percent": 100,
      "fixed": 0,
      "shareFees": true,
      "storeId": "cm5t0a9qz0000ls08p4r7c2kd",
      "splitId": null
    }
  ],
  "fees": {
    "amount": 174,
    "payFeeAmount": 174,
    "chkFeeAmount": 0,
    "memFeeAmount": 0
  },
  "utms": {
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "black-friday-2026",
    "utmContent": "banner-topo",
    "utmTerm": "tenis-de-corrida",
    "src": "blog-artigo-1",
    "sck": "lista-quente"
  },
  "orderId": null,
  "recrInvoiceId": null,
  "externalRef": "order_test_456789",
  "notificationUrl": "https://example-webhook.test/notifications",
  "metadata": null,
  "paidAt": null,
  "refundedAt": null,
  "createdAt": "2026-01-19T17:34:23.491Z",
  "updatedAt": "2026-01-19T17:34:23.491Z"
}
JSON
{
  "id": "cm6p1y2b40003ls08f7k1m9wq",
  "amount": 2500,
  "method": "BOLETO",
  "currency": "BRL",
  "status": "PENDING",
  "description": "Compra de produto de teste",
  "installments": 1,
  "discount": null,
  "payer": {
    "name": "John Doe",
    "taxId": "12345678909",
    "email": "john.doe@example.com",
    "phone": "+5511999990000"
  },
  "items": [
    {
      "quantity": 1,
      "name": "Produto Teste",
      "price": 1000,
      "type": "PHYSICAL"
    }
  ],
  "delivery": {
    "fee": 1500,
    "tracking": null,
    "address": {
      "zipCode": "01001-000",
      "country": "BR",
      "state": "SP",
      "city": "São Paulo",
      "neighborhood": "Centro",
      "line1": "Rua Exemplo",
      "line2": "Apto 45",
      "streetNumber": "123"
    }
  },
  "data": {
    "method": "BOLETO",
    "barcode": "34194123400000010001790001043510049102015000",
    "digitableLine": "34191.79001 01043.510047 91020.150008 4 12340000001000"
  },
  "splits": [
    {
      "index": 1,
      "amount": 2500,
      "currency": "BRL",
      "percent": 100,
      "fixed": 0,
      "shareFees": true,
      "storeId": "cm5t0a9qz0000ls08p4r7c2kd",
      "splitId": null
    }
  ],
  "fees": {
    "amount": 349,
    "payFeeAmount": 349,
    "chkFeeAmount": 0,
    "memFeeAmount": 0
  },
  "utms": {
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "black-friday-2026",
    "utmContent": "banner-topo",
    "utmTerm": "tenis-de-corrida",
    "src": "blog-artigo-1",
    "sck": "lista-quente"
  },
  "orderId": null,
  "recrInvoiceId": null,
  "externalRef": "order_test_789456",
  "notificationUrl": "https://example-webhook.test/notifications",
  "metadata": null,
  "paidAt": null,
  "refundedAt": null,
  "createdAt": "2026-01-19T17:38:39.973Z",
  "updatedAt": "2026-01-19T17:38:39.973Z"
}
JSON
{
  "id": "cm6p1y9c10005ls08a4n6t2xe",
  "amount": 25000,
  "method": "SPEI",
  "currency": "MXN",
  "status": "PENDING",
  "description": "Compra de produto de teste",
  "installments": 1,
  "discount": null,
  "payer": {
    "name": "Juan Perez",
    "taxId": "PEPJ800101ABC",
    "email": "juan.perez@example.com",
    "phone": "+525555550000"
  },
  "items": [
    {
      "quantity": 1,
      "name": "Produto Teste",
      "price": 25000,
      "type": "DIGITAL"
    }
  ],
  "delivery": null,
  "data": {
    "method": "SPEI",
    "speiClabe": "646180111812345678",
    "transferBankName": "STP",
    "transferBeneficiary": "Comercio MX",
    "transferReference": "pedido-123"
  },
  "splits": [
    {
      "index": 1,
      "amount": 25000,
      "currency": "MXN",
      "percent": 100,
      "fixed": 0,
      "shareFees": true,
      "storeId": "cm5t0a9qz0000ls08p4r7c2kd",
      "splitId": null
    }
  ],
  "fees": {
    "amount": 500,
    "payFeeAmount": 500,
    "chkFeeAmount": 0,
    "memFeeAmount": 0
  },
  "utms": null,
  "orderId": null,
  "recrInvoiceId": null,
  "externalRef": "order_test_321654",
  "notificationUrl": "https://example-webhook.test/notifications",
  "metadata": null,
  "paidAt": null,
  "refundedAt": null,
  "createdAt": "2026-01-19T17:38:39.973Z",
  "updatedAt": "2026-01-19T17:38:39.973Z"
}
JSON
{
  "id": "cm6p1ytm80009ls08b3e7q6ha",
  "amount": 25000,
  "method": "OXXO",
  "currency": "MXN",
  "status": "PENDING",
  "description": "Compra de produto de teste",
  "installments": 1,
  "discount": null,
  "payer": {
    "name": "Juan Perez",
    "taxId": "PEPJ800101ABC",
    "email": "juan.perez@example.com",
    "phone": "+525555550000"
  },
  "items": [
    {
      "quantity": 1,
      "name": "Produto Teste",
      "price": 25000,
      "type": "DIGITAL"
    }
  ],
  "delivery": null,
  "data": {
    "method": "OXXO",
    "oxxoCode": "93000012345678"
  },
  "splits": [
    {
      "index": 1,
      "amount": 25000,
      "currency": "MXN",
      "percent": 100,
      "fixed": 0,
      "shareFees": true,
      "storeId": "cm5t0a9qz0000ls08p4r7c2kd",
      "splitId": null
    }
  ],
  "fees": {
    "amount": 500,
    "payFeeAmount": 500,
    "chkFeeAmount": 0,
    "memFeeAmount": 0
  },
  "utms": null,
  "orderId": null,
  "recrInvoiceId": null,
  "externalRef": "order_test_321654",
  "notificationUrl": "https://example-webhook.test/notifications",
  "metadata": null,
  "paidAt": null,
  "refundedAt": null,
  "createdAt": "2026-01-19T17:38:39.973Z",
  "updatedAt": "2026-01-19T17:38:39.973Z"
}
JSON
{
  "id": "cm6p1z4p2000bls08k9d2v5ny",
  "amount": 25000,
  "method": "QR_INTEROPERABLE",
  "currency": "ARS",
  "status": "PENDING",
  "description": "Compra de produto de teste",
  "installments": 1,
  "discount": null,
  "payer": {
    "name": "Martina Gomez",
    "taxId": "20123456786",
    "email": "martina.gomez@example.com",
    "phone": "+5491155550000"
  },
  "items": [
    {
      "quantity": 1,
      "name": "Produto Teste",
      "price": 25000,
      "type": "DIGITAL"
    }
  ],
  "delivery": null,
  "data": {
    "method": "QR_INTEROPERABLE",
    "qrInteroperableCode": "00020101021243650016COM.MERCADOLIBRE..."
  },
  "splits": [
    {
      "index": 1,
      "amount": 25000,
      "currency": "ARS",
      "percent": 100,
      "fixed": 0,
      "shareFees": true,
      "storeId": "cm5t0a9qz0000ls08p4r7c2kd",
      "splitId": null
    }
  ],
  "fees": {
    "amount": 500,
    "payFeeAmount": 500,
    "chkFeeAmount": 0,
    "memFeeAmount": 0
  },
  "utms": null,
  "orderId": null,
  "recrInvoiceId": null,
  "externalRef": "order_test_654987",
  "notificationUrl": "https://example-webhook.test/notifications",
  "metadata": null,
  "paidAt": null,
  "refundedAt": null,
  "createdAt": "2026-01-19T17:38:39.973Z",
  "updatedAt": "2026-01-19T17:38:39.973Z"
}
JSON
{
  "id": "cm6p1zd7f000dls08x1s4g8tm",
  "amount": 25000,
  "method": "CVU",
  "currency": "ARS",
  "status": "PENDING",
  "description": "Compra de produto de teste",
  "installments": 1,
  "discount": null,
  "payer": {
    "name": "Martina Gomez",
    "taxId": "20123456786",
    "email": "martina.gomez@example.com",
    "phone": "+5491155550000"
  },
  "items": [
    {
      "quantity": 1,
      "name": "Produto Teste",
      "price": 25000,
      "type": "DIGITAL"
    }
  ],
  "delivery": null,
  "data": {
    "method": "CVU",
    "cvuAccount": "0000003100012345678901",
    "transferBankName": "Banco AR",
    "transferBeneficiary": "Comercio AR",
    "transferReference": "pedido-ar-1"
  },
  "splits": [
    {
      "index": 1,
      "amount": 25000,
      "currency": "ARS",
      "percent": 100,
      "fixed": 0,
      "shareFees": true,
      "storeId": "cm5t0a9qz0000ls08p4r7c2kd",
      "splitId": null
    }
  ],
  "fees": {
    "amount": 500,
    "payFeeAmount": 500,
    "chkFeeAmount": 0,
    "memFeeAmount": 0
  },
  "utms": null,
  "orderId": null,
  "recrInvoiceId": null,
  "externalRef": "order_test_789123",
  "notificationUrl": "https://example-webhook.test/notifications",
  "metadata": null,
  "paidAt": null,
  "refundedAt": null,
  "createdAt": "2026-01-19T17:38:39.973Z",
  "updatedAt": "2026-01-19T17:38:39.973Z"
}
Nesta página
  • Descrição
  • Padrão de Timezone
  • Evento e Reentrega
  • Validação Opcional do Webhook
  • Endpoint de Notificação
  • Status do Pagamento
  • Formato do Payload