o payload é composto pelo evento (event), assinatura para verificação (signature) e os dados da transação (data), exemplo:
PAYLOAD DE TRANSAÇÕES:
O nome do evento inicia sempre com o prefixo CHARGE e segue com o status da transação, exemplo:
CHARGE-APPROVED
O nó data contém os mesmos dados que são retornados na consulta por transação (https://dom-pagamentos.readme.io/reference/consultar-transacao), exemplo:
{
"event": "CHARGE-PENDING",
"signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6ImY5NGJkY2M4LTM4ZjAtNDk3ZS1iNTBkLWI5YmZiM2Y2OGYzYSIsImV4cCI6MTcxMzE5NDY4OH0.ItLRYLxvlU4G7t_yJZRLf-EVjUvQ8Iu9lWNx2tFt8gU",
"data": {
"id": "f94bdcc8-38f0-497e-b50d-b9bfb3f68f3a",
"created_at": "2024-04-15 14:24:47",
"updated_at": "2024-04-15 14:24:47",
"cod_external": "A125",
"amount": 2000,
"liquid_amount": 1500,
"liquidation": [],
"refunds": {
"details": [],
"total_refunds": 0
},
"currency": "BRL",
"status": "pending",
"payment_method": "pix",
"card_code_auth": null,
"card_brand": null,
"card_bin": null,
"installments": "1",
"boleto_url": null,
"pix_qrcode": "https://dompagamentos.com.br/8183b107-a02f-4634-80a3-7ad5a208e56e-b5f5/test/qr_code",
"pix_content": "http://dompagamentos.com.br/8183b107-a02f-4634-80a3-7ad5a208e56e-b5f5/test/pay",
"pix_expire": "2024-04-15 14:34:47",
"items": [
{
"reference": "",
"description": "Produto A",
"price": 2000,
"quantity": 1
}
],
"customer": {
"name": "João da Silva",
"email": "[email protected]",
"mobile_phone": "(48) 9 99999999",
"document": "11111111111",
"document_type": "CPF",
"birthdate": "1981-06-02",
"gender": "male",
"address": {
"street": "Rua do Joao",
"number": "1",
"neighborhood": "Trindade",
"zip_code": "88036230",
"city": "Florianópolis",
"state": "SC"
}
},
"shipping": null,
"metadata": "{'dado':'dado da loja'}",
"query_param": "{'utm_source':'facebook','utm_medium':'social','utm_campaign':'primavera2025'}",
"postbackUrl": "https://webhook.site/0d26cec2-8cfa-4b38-b62e-8824c5cb5b23",
"type": "physical",
"serial_number": "2BG55VCAV8",
"relations": {
"id_invoice": null,
"id_link_payment": "3ea27e1a-0f67-44d0-85ee-c82a8fb14809",
"id_subscriber": null
}
}
}
PAYLOAD DE ASSINATURAS:
O nome do evento inicia sempre com o prefixo SIGNATURE e segue com a descrição do evento que disparou o gatilho, exemplo:
SIGNATURE-CREATED
O nó data contém os mesmos dados que são retornados no endpoint que disparou o gatilho, exemplo:
{
"event": "SIGNATURE-CREATED",
"signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6ImY5NGJkY2M4LTM4ZjAtNDk3ZS1iNTBkLWI5YmZiM2Y2OGYzYSIsImV4cCI6MTcxMzE5NDY4OH0.ItLRYLxvlU4G7t_yJZRLf-EVjUvQ8Iu9lWNx2tFt8gU",
"data": {
"id": "389ffa5a-c95b-4258-927a-d48cc6829ca3",
"customer_id": "4bfc6124-ceee-4f6f-9f29-75059b3f5d9c",
"plan_id": "",
"external_reference": "Assinatura 001",
"auto_recurring": {
"description": "Plano Ouro",
"value": 58.99,
"frequency": 1,
"frequency_type": "MONTH",
"repetitions": 0,
"billing_type": "prepaid",
"billing_day": 0,
"retry_days": 3
},
"payment_method": "credit_card",
"card": {
"installments": 1,
"token": "2c2b1bf4085716225061bb09e1d6df1094239e64efa737b9f233aed00c3011fc"
},
"cashback_active": false,
"postbackurl": "https://seudominio.com.br/webhook",
"metadata": "{'meta':'ok'}",
"current_cycle": 1,
"start_date_invoice": "2024-10-10",
"next_date_invoice": "2024-10-10",
"end_date_invoice": "",
"status": "active",
"created_at": "2024-10-01T16:00:00Z",
"updated_at": "2019-10-01T17:00:00Z",
"platform": [
{
"fee_details": {
"fee_transaction": {
"type": "variable",
"value": 10
},
"fee_cashback": {
"type": "fixed",
"value": 5
}
}
}
]
}
}
{
"event": "SIGNATURE-INVOICE-CREATED",
"signature": "eyJ0eX23OiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjU4MDQ3NzQxLTBiNzMtNDVmZC1iNWQ0LTBjZWZhOTU4NWI3YyIsImV4cCI6MTczMzc4NDM2Nn0.Is44ch4dUYMs69ejUO6Vd3PrxeUB3aFXZ5tqks0uagk",
"data": {
"id": "58047741-0b73-45fd-b5d4-0cefa9585b7c",
"cycle": 0,
"description": "Plano Ouro",
"created_at": "2024-12-09T07:46:06Z",
"updated_at": "2024-12-09T07:46:06Z",
"due_date": "2024-12-09",
"retries": 0,
"process_date": null,
"processing_mode": "AUTO",
"external_reference": "Assinatura 001",
"amount": 10,
"status": "scheduled",
"status_details": "Agendado",
"metadata": "{'meta':'ok'}",
"postbackUrl": "https://webhook.site/f01346a3-c35b-4547-abd7-01b1c3004968",
"card": {
"holder_name": "João da Silva",
"last_4_digits": "9852",
"brand": "master",
"expire": "1/2033"
},
"relations": {
"id_link_payment":"",
"id_subscriber":"a70a50ce-496a-4a23-a73f-0d464674b259"
}
}
}
PAYLOAD DE SUBCONTAS:
O nome do evento inicia sempre com o prefixo SUBACCOUNT e segue com a descrição do evento que disparou o gatilho, exemplo:
SUBACCOUNT-CREATED
O nó data contém os mesmos dados que são retornados no endpoint que disparou o gatilho, exemplo:
{
"event": "SUBACCOUNT-CREATED",
"signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6ImY5NGJkY2M4LTM4ZjAtNDk3ZS1iNTBkLWI5YmZiM2Y2OGYzYSIsImV4cCI6MTcxMzE5NDY4OH0.ItLRYLxvlU4G7t_yJZRLf-EVjUvQ8Iu9lWNx2tFt8gU",
"data": {
"id": "4bfc6124-ceee-4f6f-9f29-75059b3f5d9c",
"corporate_doc": "52711237000184",
"corporate_name": "Dom Digital",
"name": "Dom Pagamentos",
"external_reference": "REF_COMPANY_001",
"address": {
"street": "Av. General",
"number": "s/n",
"neighborhood": "Centro",
"zip_code": "88036200",
"city": "Florianópolis",
"state": "SC"
},
"partner_adm": {
"name": "joão da Silva",
"doc": "11111111111",
"birthdate": "2000-01-01",
"email": "[email protected]",
"phone": "48991191311"
},
"support": {
"phone": "48999999999",
"email": "[email protected]",
"site": "https://dompagamentos.com.br"
},
"financial_pixout": {
"key": "52711237000184",
"type": "CNPJ"
},
"status": "approved",
"msg": "",
"credentials": {
"public_ley": "pk_cb389d86-3025-4d49-b029-2e238501bc40",
"token": "2c8e65c43f4870f5e82f0ab2cvc94141ed90a78088ac310dc4fb2222fc5bcb99"
},
"created_at": "2024-10-01T15:36:00Z",
"updated_at": "2024-10-01T15:36:00Z"
}
}
{
"event": "SUBACCOUNT-CANCELLED",
"signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6ImY5NGJkY2M4LTM4ZjAtNDk3ZS1iNTBkLWI5YmZiM2Y2OGYzYSIsImV4cCI6MTcxMzE5NDY4OH0.ItLRYLxvlU4G7t_yJZRLf-EVjUvQ8Iu9lWNx2tFt8gU",
"data": {
"id": "4bfc6124-ceee-4f6f-9f29-75059b3f5d9c",
"corporate_doc": "52711237000184",
"corporate_name": "Dom Digital",
"name": "Dom Pagamentos",
"external_reference": "REF_COMPANY_001",
"address": {
"street": "Av. General",
"number": "s/n",
"neighborhood": "Centro",
"zip_code": "88036200",
"city": "Florianópolis",
"state": "SC"
},
"partner_adm": {
"name": "joão da Silva",
"doc": "11111111111",
"birthdate": "2000-01-01",
"email": "[email protected]",
"phone": "48991191311"
},
"support": {
"phone": "48999999999",
"email": "[email protected]",
"site": "https://dompagamentos.com.br"
},
"financial_pixout": {
"key": "52711237000184",
"type": "CNPJ"
},
"status": "cancelled",
"msg": "Conta descredenciada por critérios de risco",
"created_at": "2024-10-01T15:36:00Z",
"updated_at": "2024-10-01T15:36:00Z"
}
}
{
"event": "SUBACCOUNT-CHANGED",
"signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6ImY5NGJkY2M4LTM4ZjAtNDk3ZS1iNTBkLWI5YmZiM2Y2OGYzYSIsImV4cCI6MTcxMzE5NDY4OH0.ItLRYLxvlU4G7t_yJZRLf-EVjUvQ8Iu9lWNx2tFt8gU",
"data": {
"id": "4bfc6124-ceee-4f6f-9f29-75059b3f5d9c",
"corporate_doc": "52711237000184",
"corporate_name": "Dom Digital",
"name": "Dom Pagamentos",
"external_reference": "REF_COMPANY_001",
"address": {
"street": "Av. General",
"number": "s/n",
"neighborhood": "Centro",
"zip_code": "88036200",
"city": "Florianópolis",
"state": "SC"
},
"partner_adm": {
"name": "joão da Silva",
"doc": "11111111111",
"birthdate": "2000-01-01",
"email": "[email protected]",
"phone": "48991191311"
},
"support": {
"phone": "48999999999",
"email": "[email protected]",
"site": "https://dompagamentos.com.br"
},
"financial_pixout": {
"key": "52711237000184",
"type": "CNPJ"
},
"status": "blocked",
"msg": "Conta bloqueada para operações por critérios do setor de risco",
"created_at": "2024-10-01T15:36:00Z",
"updated_at": "2024-10-01T15:36:00Z"
}
}
PAYLOAD DE PIXOUT:
Sempre é encaminhado o payload completo do lote.
{
"event": "PIXOUT-BATCH-CHANGED",
"signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6ImY5NGJkY2M4LTM4ZjAtNDk3ZS1iNTBkLWI5YmZiM2Y2OGYzYSIsImV4cCI6MTcxMzE5NDY4OH0.ItLRYLxvlU4G7t_yJZRLf-EVjUvQ8Iu9lWNx2tFt8gU",
"data":
{
"batch_id": "37f86bcf-1f8a-4470-86f7-860cdd86522d",
"description": "Pagamentos em lote",
"created_at": "2021-08-16T14:57:59.000Z",
"postbackUrl": "",
"total_gross": 4.3,
"total_transfer": 3.5,
"total_fee": 0.8,
"receivers": [
{
"transfer_id": "bbafbcca-56ac-4cbc-af3e-c22aad29d431",
"status": "paid",
"status_detail": "",
"name": "Maria da Silva",
"document": "11111111111",
"pix_key_type": "CPF",
"pix_key": "11111111111",
"external_reference": "PIX01",
"amount": 1.5,
"idempotency_key": "",
"bank_receipt_url": "https://dompagamentos.com.br/receipt/bbafbcca-56ac-4cbc-af3e-c22aad29d431",
"paid_date": "2025-01-21"
},
{
"transfer_id": "b9c71f1b-9020-430d-a59d-b4175733ca8c",
"status": "error",
"status_detail": "Erro na chave pix",
"name": "João da Silva",
"document": "22222222222",
"pix_key_type": "EMAIL",
"pix_key": "[email protected]",
"external_reference": "PIX02",
"amount": 2,
"idempotency_key": "",
"bank_receipt_url": "",
"paid_date": ""
}
]
}
}