Payloads
Payload é o conteúdo que é enviado na notificação. Cada evento possui um payload diferente. Em seguida o que você pode esperar de cada evento.
A regra é que todos os payloads possuem as chaves event_code
, webhook
, object
, changes
.
event_code | código do evento que originou a notificação. |
webhook | informações do webhook para o qual a notificação foi criada. |
object | informações do recurso relativo ao evento. |
changes | mudanças realizadas no recurso (no caso dos eventos *.updated) |
ping
{ "event_code": "ping", "webhook": { "id": 11, "url": "https://requestb.in" } }
bank_billet.*
{ "object": { "id": 1, "url": "https://bole.to/6/qzoavp", "line": "03399.12347 56700.000005 00033.701012 1 71190000003223", "meta": null, "notes": null, "amount": 217.6, "extra1": null, "extra2": null, "status": "paid", "formats": { "pdf": "https://bole.to/6/qzoavp.pdf", "png": "https://bole.to/6/qzoavp.png" }, "paid_at": "2017-04-17", "bank_rate": 0.0, "carne_url": null, "expire_at": "2017-04-24", "paid_bank": "237", "acceptance": "N", "created_at": "2017-04-17", "our_number": "00002957", "updated_at": "2017-04-18", "description": "Recarga de benefícios", "paid_agency": "01200", "paid_amount": 217.6, "agency_digit": null, "extra1_digit": null, "extra2_digit": null, "instructions": null, "account_digit": "1", "agency_number": "1234", "document_date": null, "document_type": "DM", "payment_place": "Pagável em qualquer banco até a data de vencimento.", "remittance_id": null, "account_number": "00001221", "customer_email": "suporte@boletosimples.com.br", "customer_state": "RJ", "fine_for_delay": null, "guarantor_name": null, "installment_id": null, "created_via_api": true, "document_number": null, "beneficiary_name": "Boleto Simples Cobranças Ltda.", "customer_address": "Rua da Glória", "customer_zipcode": "20241180", "customer_cnpj_cpf": "05.813.794/0001-26", "bank_contract_slug": "santander-bs-101", "customer_city_name": "Rio de Janeiro", "guarantor_cnpj_cpf": null, "installment_number": null, "beneficiary_address": "Rua da Glória, 101", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "customer_person_name": "Boleto Simples Cobranças Ltda.", "customer_person_type": "juridical", "processed_our_number": "00002957-2", "bank_billet_layout_id": null, "customer_neighborhood": "CENTRO", "customer_phone_number": null, "late_payment_interest": null, "bank_billet_account_id": 1, "bank_billet_discharges": [ { "id": 1, "line": "1020817949600011400014542047 0000295728 44 1061704170000295728 1704170000000021760237012000100000000000000000000000000 0000000000000000000000000000000000000000000000021760000000000000000000000000000 04 025869000000000000000010", "occurrence": "06", "discharge_id": 6488, "processed_at": "2017-04-18", "bank_billet_id": 1, "occurrence_error": "04", "occurrence_detail": "Liquidação", "date_of_occurrence": "2017-04-17", "occurrence_error_detail": "Compensação Eletrônica" } ], "customer_address_number": null, "customer_subscription_id": null, "processed_our_number_raw": "0000295728", "beneficiary_assignor_code": "1234/1234567", "customer_address_complement": null }, "changes": { "status": [ "opened", "paid" ], "paid_at": [ null, "2017-04-17" ], "updated_at": [ "2017-04-17 15:23:24 -0300", "2017-04-18 09:18:13 -0300" ], "banco_recebedor": [ null, "237" ], "bank_rate_cents": [ null, 0 ], "paid_amount_cents": [ null, 21760 ], "agencia_recebedora": [ null, "01200" ] }, "event_code": "bank_billet.paid", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br", "first_try": "2017-04-18 09:18:18 -0300" } }
customer.*
{ "object": { "id": 1, "email": null, "notes": null, "state": "RJ", "address": "Rua da Glória, 36", "zipcode": "99354050", "cnpj_cpf": "05.813.794/0001-26", "email_cc": null, "city_name": "Brusque", "person_name": "Boleto Simples Cobranças Ltda.", "person_type": "juridical", "neighborhood": "Centro", "phone_number": "9999999999", "mobile_number": null, "address_number": "0", "created_via_api": true, "mobile_local_code": null, "address_complement": "Rua Glória, 36", "contact_person": "José da Silva" }, "event_code": "customer.created", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br", "first_try": "2017-04-18 09:46:58 -0300" } }
customer_subscription.*
{ "object": { "id": 1, "cycle": "monthly", "email": "", "amount": 150.0, "end_at": null, "created_at": "2017-03-31", "updated_at": "2017-03-31", "customer_id": 1, "description": "MANUTENÇÃO MENSAL DO HOTSITE", "instructions": "", "next_billing": "2017-04-10", "fine_for_delay": 2.0, "bank_billet_ids": [ ], "created_via_api": false, "days_in_advance": 10, "bank_billet_layout_id": 1, "late_payment_interest": 1.0, "bank_billet_account_id": 1 }, "event_code": "customer_subscription.created", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br", "first_try": "2017-04-18 09:46:58 -0300" } }
installment.*
{ "object": { "id": 1, "url": "https://bole.to/6/lbvaaz/carne", "cycle": "monthly", "total": 1, "amount": 765.0, "end_at": "2017-06-12", "status": "generated", "start_at": "2017-04-12", "created_at": "2017-04-06", "updated_at": "2017-04-06", "customer_id": 1, "description": "DESENVOLVIMENTO DO WEBSITE", "bank_billets": [ { "id": 1, "url": "https://bole.to/6/pnvjjv", "line": "10496.00297 94000.100043 00005.034509 5 71880000076500", "meta": null, "notes": null, "amount": 765.0, "extra1": "999999", "extra2": null, "status": "opened", "formats": { "pdf": "https://bole.to/6/pnvjjv.pdf", "png": "https://bole.to/6/pnvjjv.png", "carne": "https://bole.to/6/pnvjjv/carne" }, "paid_at": null, "bank_rate": 0.0, "carne_url": "https://bole.to/6/pnvjjv/carne", "expire_at": "2017-06-12", "paid_bank": null, "acceptance": "N", "created_at": "2017-04-06", "our_number": "000000000050345", "updated_at": "2017-04-06", "description": "DESENVOLVIMENTO DO WEBSITE", "paid_agency": null, "paid_amount": 0.0, "agency_digit": "0", "extra1_digit": null, "extra2_digit": null, "instructions": "", "account_digit": "9", "agency_number": "9999", "document_date": null, "document_type": "DM", "payment_place": "Pagável em qualquer banco até a data de vencimento.", "remittance_id": null, "account_number": "0000293", "customer_email": null, "customer_state": "AL", "fine_for_delay": 2.0, "guarantor_name": null, "installment_id": 1, "created_via_api": false, "document_number": null, "beneficiary_name": "Boleto Simples Cobranças Ltda.", "customer_address": "Rua Jornalista", "customer_zipcode": "99999999", "customer_cnpj_cpf": "05.813.794/0001-26", "bank_contract_slug": "caixa-rg", "customer_city_name": "Rio de Janeiro", "guarantor_cnpj_cpf": null, "installment_number": 3, "beneficiary_address": "Avenida, 326", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "customer_person_name": "Boleto Simples Cobranças Ltda.", "customer_person_type": "juridical", "processed_our_number": "14000000000050345-8", "bank_billet_layout_id": 1, "customer_neighborhood": "Centro", "customer_phone_number": "9999999999", "late_payment_interest": 3.0, "bank_billet_account_id": 1, "customer_address_number": "255", "customer_subscription_id": null, "processed_our_number_raw": "140000000000503458", "beneficiary_assignor_code": "9999/600299-4", "customer_address_complement": "" } ], "instructions": "", "fine_for_delay": 2.0, "bank_billet_ids": [ 1 ], "created_via_api": false, "bank_billet_layout_id": 1, "late_payment_interest": 3.0, "bank_billet_account_id": 1 }, "changes": { "status": [ "processed", "generated" ], "updated_at": [ "2017-04-06 20:30:53 -0300", "2017-04-06 20:31:09 -0300" ] }, "event_code": "installment.generated", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br", "first_try": "2017-04-06 20:31:14 -0300" } }
user.*
{ "object": { "id": 1, "cpf": "046.665.234-80", "email": "suporte@boletosimples.com.br", "gender": "Masculino", "full_name": "Luiz Silva", "last_name": "Silva", "login_url": "https://app.kobana.com.br/welcome?email=suporte%boletosimples.com.br&token=TJEz4fMFv2Q4jp8SLj6q", "first_name": "Luiz", "father_name": null, "middle_name": null, "mother_name": "Maria Oliveira", "account_type": "juridical", "checkout_url": "https://checkout.boletosimples.com.br/#boletosimples;b2e55674f80ee49073f272626e6fbc18", "phone_number": "9999999999", "subscription": { "id": 1, "cycle": "annual", "amount": 405.0, "contract": "Plano alterado para anual, por solicitação do usuário.\r\n", "discount": 0, "created_at": "2016-12-23", "updated_at": "2017-03-05", "canceled_at": null, "next_billing": "2017-09-05", "exceeded_price": 0.42, "integration_price": 0.13, "number_of_billets": 250, "number_of_bank_billet_accounts": 1 }, "account_level": 1, "address_state": "RJ", "billing_email": "", "business_cnpj": "05.813.794/0001-26", "business_name": "Boleto Simples Cobranças Ltda.", "business_type": "individual", "configuration": null, "date_of_birth": "1984-02-16", "address_number": "326", "business_website": "http://www.boletosimples.com.br", "address_city_name": "Rio de Janeiro", "business_category": 1020, "address_complement": "Sala 06", "address_postal_code": "99999999", "address_street_name": "Avenida Espíndola", "business_legal_name": "Boleto Simples Cobranças Ltda.", "address_neighborhood": "Centro", "business_subcategory": 2229 }, "changes": { "updated_at": [ "2017-04-17 12:49:57 -0300", "2017-04-17 15:38:48 -0300" ], "sign_in_count": [ 326, 327 ], "last_sign_in_at": [ "2017-04-14 09:54:44 -0300", "2017-04-17 12:49:57 -0300" ], "current_sign_in_at": [ "2017-04-17 12:49:57 -0300", "2017-04-17 15:38:48 -0300" ], "current_sign_in_ip": [ "179.235.185.186", "179.235.167.233" ] }, "event_code": "user.updated", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br", "first_try": "2017-04-17 15:38:58 -0300" } }
remittance.*
{ "object": { "id": 1, "filename": "1804193.REM", "created_via_api": false, "status": "sent", "bank_billet_account_id": 1976, "created_at": "2018-04-19", "processed_at": "2018-04-19", "url": null, "bank_billet_ids": [ 1 ], "remittance_number": 1, "sent_via_integration": "2018-04-19", "bank_billet_remittances": [ { "id": 1, "our_code": "1001", "occurrence": "01", "remittance_id": 1, "bank_billet_id": 1, "bank_billet_account_id": 1, "processed_at": "2018-04-19", "occurrence_detail": "Entrada de Título", "created_at": "2018-04-19" } ] }, "changes": { "status": [ "unprocessed", "processed" ], "updated_at": [ "2017-04-18 09:12:13 -0300", "2017-04-18 09:12:13 -0300" ] }, "event_code": "remittance.processed", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br", "first_try": "2017-04-18 09:12:22 -0300" } }
discharge.*
{ "object": { "id": 1, "filename": "1804191.RET", "processed_at": "2018-04-19", "created_via_api": false, "status": "processed", "bank_billet_account_id": 1, "created_via_integration": "2018-04-19T03:03:06-03:00", "bank_billet_discharges": [ { "id": 1, "occurrence": "06", "our_occurrence": "2006", "date_of_occurrence": "2018-04-18", "discharge_id": 1, "bank_billet_id": 1, "occurrence_error": "0000000004", "line_parsed": { "iof": "0", "line_t": "7560001300007T 0604327000000000366680000070439401014 100000000007043920042018000000000014000341056140 091000010759039984 00000000000000000000002200000000004 ", "line_u": "7560001300008U 060000000000000000000000000000000000000000000000000000000000000000000000140000000000000140000000000000000000000000000000001804201819042018 00000000000000000000000 75600000000000000000000 ", "paid_at": "2018-04-18", "discount": "0", "bank_rate": "220", "credit_at": "2018-04-19", "error_code": "0000000004", "event_type": "06", "our_number": "00704394", "billet_fine": "0", "other_fines": "0", "paid_amount": "14000", "other_credit": "0", "value_rebate": "0", "agency_number": "4327", "credit_amount": "14000", "account_number": "00003666", "banco_recebedor": "341", "agencia_recebedora": "05614", "processed_our_number_raw": "00704394" }, "processed_at": "2018-04-19", "occurrence_detail": "Liquidação Normal", "occurrence_error_detail": "756 - 06 - 0000000004 - Não Reconhecido" }, { "id": 2, "occurrence": "06", "our_occurrence": "2006", "date_of_occurrence": "2018-04-18", "discharge_id": 1, "bank_billet_id": 2, "occurrence_error": "0000000004", "line_parsed": { "iof": "0", "line_t": "7560001300005T 0604327000000000366680000070424401014 100000000007042419042018000000000005000341032120 092027613530000161 00000000000000000000002200000000004 ", "line_u": "7560001300006U 060000000000000000000000000000000000000000000000000000000000000000000000050000000000000050000000000000000000000000000000001804201819042018 00000000000000000000000 75600000000000000000000 ", "paid_at": "2018-04-18", "discount": "0", "bank_rate": "220", "credit_at": "2018-04-19", "error_code": "0000000004", "event_type": "06", "our_number": "00704244", "billet_fine": "0", "other_fines": "0", "paid_amount": "5000", "other_credit": "0", "value_rebate": "0", "agency_number": "4327", "credit_amount": "5000", "account_number": "00003666", "banco_recebedor": "341", "agencia_recebedora": "03212", "processed_our_number_raw": "00704244" }, "processed_at": "2018-04-19", "occurrence_detail": "Liquidação Normal", "occurrence_error_detail": "756 - 06 - 0000000004 - Não Reconhecido" }, { "id": 3, "occurrence": "06", "our_occurrence": "2006", "date_of_occurrence": "2018-04-18", "discharge_id": 1, "bank_billet_id": 3, "occurrence_error": "0000000004", "line_parsed": { "iof": "0", "line_t": "7560001300003T 0604327000000000366680000070417201014 100000000007041718042018000000000041233001037960 091000022126830225 00000000000000000000002200000000004 ", "line_u": "7560001300004U 060000000000000000000000000000000000000000000000000000000000000000000000412330000000000412330000000000000000000000000000001804201819042018 00000000000000000000000 75600000000000000000000 ", "paid_at": "2018-04-18", "discount": "0", "bank_rate": "220", "credit_at": "2018-04-19", "error_code": "0000000004", "event_type": "06", "our_number": "00704172", "billet_fine": "0", "other_fines": "0", "paid_amount": "41233", "other_credit": "0", "value_rebate": "0", "agency_number": "4327", "credit_amount": "41233", "account_number": "00003666", "banco_recebedor": "001", "agencia_recebedora": "03796", "processed_our_number_raw": "00704172" }, "processed_at": "2018-04-19", "occurrence_detail": "Liquidação Normal", "occurrence_error_detail": "756 - 06 - 0000000004 - Não Reconhecido" }, { "id": 4, "occurrence": "02", "our_occurrence": "2001", "date_of_occurrence": "2018-04-18", "discharge_id": 1, "bank_billet_id": 4, "occurrence_error": "", "line_parsed": { "iof": "0", "line_t": "7560001300001T 0204327000000000366680000070439401014 100000000007043920042018000000000014000756043270 091000010759039984 0000000000000000000000020 ", "line_u": "7560001300002U 020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001804201800000000 00000000000000000000000 75600000000000000000000 ", "paid_at": "2018-04-18", "discount": "0", "bank_rate": "20", "credit_at": null, "error_code": "", "event_type": "02", "our_number": "00704394", "billet_fine": "0", "other_fines": "0", "paid_amount": "0", "other_credit": "0", "value_rebate": "0", "agency_number": "4327", "credit_amount": "0", "account_number": "00003666", "banco_recebedor": "756", "agencia_recebedora": "04327", "processed_our_number_raw": "00704394" }, "processed_at": "2018-04-19", "occurrence_detail": "Confirmação Entrada Título", "occurrence_error_detail": null } ] }, "changes": { "status": [ "unprocessed", "processed" ], "quantity": [ 0, 1 ], "updated_at": [ "2017-04-18 10:00:58 -0300", "2017-04-18 10:00:58 -0300" ], "amount_cents": [ 0, 503967 ], "processed_at": [ null, "2017-04-18 10:00:58 -0300" ] }, "event_code": "discharge.processed", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br", "first_try": "2017-04-18 10:00:59 -0300" } }
plan_subscription.*
{ "object": { "id": 1, "cycle": "monthly", "amount": 50.0, "contract": null, "discount": 0, "created_at": "2017-02-20", "updated_at": "2017-02-21", "canceled_at": null, "next_billing": "2017-03-21", "exceeded_price": 0.6, "integration_price": 0.15, "number_of_billets": 50, "number_of_bank_billet_accounts": 1 }, "event_code": "plan_subscription.activated", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br", "first_try": "2017-04-18 10:00:59 -0300" } }
bank_billet_account.*
{ "object": { "id": 1, "name": "Banrisul - 2", "extra1": "9999999", "extra2": null, "extra3": "999999999", "status": "active", "default": false, "integration": false, "agency_digit": "00", "extra1_digit": "61", "extra2_digit": null, "account_digit": "04", "agency_number": "9999", "bank_contract": { "bank": { "code": "banrisul", "name": "Banrisul", "number": "041" }, "code": "2", "name": "Cob. Direta - Agência com 4 dígitos - BDL", "slug": "banrisul-bs-4-2", "sufix": "bs-4-2", "variation": null }, "configuration": null, "account_number": "99999999", "homologated_at": "2017-01-13", "created_via_api": false, "next_our_number": "00145332", "beneficiary_name": "Boleto Simples Cobranças Ltda.", "bank_contract_slug": "banrisul-bs-4-2", "beneficiary_address": "Rua Glória", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "next_remittance_number": 2, "custom_name": "My Account" }, "changes": { "updated_at": [ "2017-03-22 16:25:35 -0300", "2017-04-13 11:04:36 -0300" ], "extra1_digit": [ null, "61" ] }, "event_code": "bank_billet_account.activated", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br", "first_try": "2017-04-13 11:04:36 -0300" } }
bank_billet_discharges.*
Contéudo do line_parsed
depende das informações que seu banco disponibiliza e do tipo de CNAB(400 ou 240).
{ "object": { "id": 4, "occurrence": "02", "our_occurrence": "2001", "date_of_occurrence": "2018-04-18", "discharge_id": 1, "bank_billet_id": 4, "occurrence_error": "", "line_parsed": { "iof": "0", "line_t": "7560001300001T 0204327000000000366680000070439401014 100000000007043920042018000000000014000756043270 091000010759039984 0000000000000000000000020 ", "line_u": "7560001300002U 020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001804201800000000 00000000000000000000000 75600000000000000000000 ", "paid_at": "2018-04-18", "discount": "0", "bank_rate": "20", "credit_at": null, "error_code": "", "event_type": "02", "our_number": "00704394", "billet_fine": "0", "other_fines": "0", "paid_amount": "0", "other_credit": "0", "value_rebate": "0", "agency_number": "4327", "credit_amount": "0", "account_number": "00003666", "banco_recebedor": "756", "agencia_recebedora": "04327", "processed_our_number_raw": "00704394" }, "processed_at": "2018-04-19", "occurrence_detail": "Confirmação Entrada Título", "occurrence_error_detail": null }, "event_code": "bank_billet_discharge.created", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br", "first_try": "2017-04-18 10:00:59 -0300" } }
bank_billet_remittance.*
{ "object": { "id": 1, "our_code": "1001", "occurrence": "01", "remittance_id": 1, "bank_billet_id": 1, "bank_billet_account_id": 1, "processed_at": "2018-04-19", "occurrence_detail": "Entrada de Título", "created_at": "2018-04-19" }, "event_code": "bank_billet_remittance.created", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br", "first_try": "2017-04-18 10:00:59 -0300" } }
*.updated
{ "object": { ... }, "changes": { "person_name": [ "Nome Antigo", "Nome Novo" ], }, "event_code": "customer.updated", "webhook": { "id": 1, "url": "http://hooks.boletosimples.com.br" } }