Pular para o conteúdo principal

Webhooks

Para toda e qualquer movimentação será enviado um webhook de “account_transaction“.

Cada transação possui um tipo de classificação (Source Sub Type). Essa classificação é utilizada para categorizar cada movimentação na conta. A lista de Source Sub Types pode ser visualizada abaixo.

Crédito em Conta

Os créditos em conta resultarão em um webhook com “data.amount” positivo, “data.origin“ sendo a conta de origem dos recursos e a “data.destination“ sendo a conta de destino dos recursos:

WEBHOOK_TYPE
account_transaction
Response Body: Pix
{
    "key": "\<ACCOUNT-KEY\>",
	"data": {
		"amount": 1000000,
		"origin": {
			"name": "Treasury Account",
			"branch": "0001",
			"document": "32402502000135",
			"account_key": "5d068423-6094-49e4-b15b-7740038295a8",
			"account_digit": "5",
			"account_number": "00002"
		},
		"timestamp": "2022-09-02T21:36:33.446120",
		"description": "329 0001 00002-5 32.402.502/0001-35 - QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
		"destination": {
			"name": "Default",
			"branch": "0001",
			"document": "09080702000105",
			"account_key": "6d30a0b1-cb90-4ceb-b1ea-5bd600cdf3c8",
			"account_digit": "2",
			"account_number": "2359934"
		},
		"reference_key": "983b4a28-7de6-4e71-97ef-60fb50c7b013",
		"reference_type": "movement_request",
		"account_balance": 1000000,
		"source_sub_type": "internal_funds_transfer",
		"transaction_key": "67a62397-2c32-4768-8485-ec9129a46654",
		"source_sub_type_str": "Transferência Interna",
		"transaction_details": {
			"payer_name": "0001",
			"receiver_name": "Default",
			"payer_account_digit": "5",
			"payer_account_branch": "",
			"payer_account_number": "1111111",
			"payer_document_number": "66681638999999",
			"receiver_account_digit": "6",
			"receiver_account_branch": "0000",
			"receiver_account_number": "34256449809",
			"receiver_conciliation_id": null,
			"receiver_document_number": "00809641658"
		}
	},
	"datetime": "2022-09-02T21:36:33.446120",
	"webhook_type": "account_transaction"
}
Response Body: Outras transações
{
    "key": "\<ACCOUNT-KEY\>",
	"data": {
		"amount": 1000000,
		"origin": {
			"name": "Treasury Account",
			"branch": "0001",
			"document": "32402502000135",
			"account_key": "5d068423-6094-49e4-b15b-7740038295a8",
			"account_digit": "5",
			"account_number": "00002"
		},
		"timestamp": "2022-09-02T21:36:33.446120",
		"description": "329 0001 00002-5 32.402.502/0001-35 - QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
		"destination": {
			"name": "Default",
			"branch": "0001",
			"document": "09080702000105",
			"account_key": "6d30a0b1-cb90-4ceb-b1ea-5bd600cdf3c8",
			"account_digit": "2",
			"account_number": "2359934"
		},
		"reference_key": "983b4a28-7de6-4e71-97ef-60fb50c7b013",
		"reference_type": "movement_request",
		"account_balance": 1000000,
		"source_sub_type": "internal_funds_transfer",
		"transaction_key": "67a62397-2c32-4768-8485-ec9129a46654",
		"source_sub_type_str": "Transferência Interna",
	},
	"datetime": "2022-09-02T21:36:33.446120",
	"webhook_type": "account_transaction"
}

Débito em Conta​

Os débitos em conta resultarão em um webhook com “data.amount” negativo, “data.origin“ sendo a conta destinatária dos recursos e a “data.destination“ sendo a conta de origem dos recursos:

WEBHOOK_TYPE
account_transaction
Response Body
{
	"key": "\<ACCOUNT-KEY\>",
	"data": {
		"amount": -45,
		"origin": {
			"name": "PIX",
			"branch": "0001",
			"document": "32402502000135",
			"account_key": "3d0e7d50-e898-49f3-b23b-05353c8a3c72",
			"account_digit": "3",
			"account_number": "00003"
		},
		"timestamp": "2022-09-02T23:00:05.326738",
		"description": "212 0001 1017372-2 ***.221.81*-** BANCO ORIGINAL S.A.",
		"destination": {
			"name": "Default",
			"branch": "0001",
			"document": "09080702000105",
			"account_key": "6d30a0b1-cb90-4ceb-b1ea-5bd600cdf3c8",
			"account_digit": "2",
			"account_number": "2359934"
		},
		"reference_key": "cea836b5-b02e-4f94-b1e2-4d575671c33d",
		"reference_type": "pix_outgoing",
		"account_balance": 999955,
		"source_sub_type": "pix_withdrawal",
		"transaction_key": "d2ba3817-26d7-4957-ab82-24f78d910a8a",
		"source_sub_type_str": "Transferência de PIX"
	},
	"datetime": "2022-09-02T23:00:05.326738",
	"webhook_type": "account_transaction"
}

Lista de source_sub_types’s:

EnumDescrição
operation_disbursementDesembolso da Operação
protest_expenseDespesas de Protesto
automatic_integrated_paymentPagamento Automático Integrado
taxImpostos
electronic_funds_feeTarifa de TED
credit_operation_feeTarifa de Abertura de Crédito
internal_funds_transferTransferência Interna
incoming_funds_transferTransferência de Entrada
outgoing_funds_transferTED
depositDepósito
withdrawalTransferência
withdrawal_reversalEstorno de Transferência
trade_funds_transferTransferência de Pagamento de Cessão
settlement_funds_transferTransferência para Liquidação
bank_slip_feeTarifa de Boleto
bank_slip_settlementLiquidação de Boleto
outgoing_funds_transfer_reversalEstorno de TED
incoming_funds_transfer_refusalTransferência Negada
electronic_funds_fee_reversalEstorno de Tarifa de TED
monthly_account_fee_reversalEstorno de Tarifa de Manutenção de Conta
bank_slip_fee_reversalEstorno de Tarifa de Boleto
correspondent_bank_transferRepasse de Correspondente Bancário
credit_analysis_feeTarifa de Análise de Crédito
credit_operation_fee_reversalEstorno de Tarifa de Abertura de Crédito
financial_investments_incomeRenda de Aplicação Financeira
bank_slip_settlement_reversalEstorno de Liquidação de Boleto
bank_slip_settlement_expense_reversalEstorno de Tarifa de liquidação de Boleto
bank_slip_settlement_incoming_reversalEstorno de Recebimento de Liquidação de Boleto
correspondent_bank_transfer_reversalEstrono de Repasse de Correspondente Bancário
credit_analysis_fee_reversalEstorno de Tarifa de Análise de Crédito
doc_expense_reversalEstorno de Tarifa de DOC
incoming_doc_reversalEstorno de Entrada de DOC
operation_disbursement_reversalEstorno de Desembolso da Operação
operation_settling_reversalEstorno de Pagamento de Operação
outgoing_doc_reversalEstorno de Saída de DOC
rebate_reversalEstorno de Rebate
settlement_funds_transfer_reversalEstorno de Transferência para Liquidação
tax_reversalEstorno de Impostos
trade_funds_transfer_reversalEstorno de Transferência de Pagamento de Cessão
bank_slip_permanency_feeTarifa de Permanência do Título
bank_slip_cancel_protest_feeTarifa de Permanência do Título
bank_slip_protest_feeTarifa de Pedido de Protesto
bank_slip_notary_office_feeCustas de Protesto
bank_slip_registration_feeTarifa de Registro
bank_slip_extension_feeTarifa de Prorrogação
bank_slip_rebate_feeTarifa de Abatimento
bank_slip_discount_feeTarifa de Desconto
bank_slip_settlement_feeTarifa de Liquidação
bank_slip_write_off_term_feeTarifa de Baixa por Decurso de Prazo
bank_slip_write_off_feeTarifa de Baixa
bank_slip_cancel_protest_write_off_feeTarifa de Sustação de Protesto com Baixa
bank_slip_notary_office_settlement_feeTarifa de Liquidação em Cartório
rebate_tax_freeRepasse por Conta e Ordem
rebate_tax_free_reversalEstorno de Repasse por Conta e Ordem
incoming_funds_transfer_reversalEstorno de Transferência Interna
bank_slip_paymentPagamento de Boleto
bank_slip_payment_reversalEstorno de Pagamento de Boleto
warranty_analysis_feeTarifa de Análise de Garantia
bank_slip_settlement_depositLiquidação de Boleto
bank_slip_payment_withdrawalPagamento de Boleto
account_setup_feeTarifa de Abertura de Conta
account_setup_fee_reversalEstorno de Tarifa de Abertura de Conta
bank_slip_payment_withdrawal_reversalEstorno de Pagamento de Boleto
incoming_anticipation_of_receivable-
incoming_credit_card_settlementLiquidação de cartão de crédito
incoming_debit_card_settlementLiquidação de cartão de débito
assignment_automatic_transferDébito de Cessão Automática
assignment_automatic_transfer_reversalEstorno de Débito de Cessão Automática
pix_feeTarifa de PIX
incoming_pix_transferEntrada de PIX
outgoing_pix_transferSaída de PIX
pix_fee_reversalEstorno de Tarifa de PIX
incoming_pix_transfer_reversalEstorno de entrada de PIX
outgoing_pix_transfer_reversalEstorno de saída de PIX
pix_depositDepósito de PIX
pix_withdrawalTransferência de PIX
pix_withdrawal_reversalEstorno de transferência de PIX
pix_chargeback_withdrawalEnvio de devolução PIX
outgoing_pix_chargebackSaída de PIX por devolução
incoming_pix_chargebackRecebimento de devolução PIX
pix_chargeback_depositEntrada de PIX por devolução
pix_chargeback_withdrawal_reversalEstorno de envio de devolução PIX
outgoing_pix_chargeback_reversalEstorno de saída de PIX por devolução
incoming_pix_chargeback_reversalEstorno de recebimento de devolução PIX
operation_pix_disbursementDesembolso PIX da Operação
operation_pix_disbursement_reversalEstorno de Desembolso PIX da Operação
receivables_inquiry_feeTarifa de Consulta de Agenda de Recebíveis
pix_deposit_reversalEstorno de Depósito de PIX
internal_pix_transferTransferência de PIX
automatic_integrated_payment_reversalEstorno de Pagamento Automático Integrado
operation_dibursement_reversalEstorno de Desembolso da Operação
available_yieldDepósito de Investimento Liquido
bank_slip_convenant_paymentPagamento de Boleto de Convênio