Esse endpoint permite o cadastro de uma configuração para um webhook. É possivel cadastrar o recebimento de webhooks de cada entidade para cada conta escrow, mas por enquanto só está habilitado os webhooks de SLC.
Os webhooks podem ser configurados de maneira distintas para cada ambiente (homologação/sandbox e produção).
Parâmetros da URL
account_id(string): ID de cadastro da conta a ser configurada.
Parâmetros da Requisição
-
webhookType(string, obrigatório): O tipo do webhook a ser cadastrado. Possíveis valores aceitos:-
SLC_PAYMENT_IN = 'SLC-PAYMENT-IN', -> entrada de SLC
-
PIX_PAYMENT_IN = 'PIX-PAYMENT-IN', -> entrada de pix
-
PIX_PAYMENT_OUT = 'PIX-PAYMENT-OUT', -> saida de pix
-
SPB_TRANSFER_IN = 'SPB-TRANSFER-IN', -> entrada de ted
-
SPB_TRANSFER_OUT = 'SPB-TRANSFER-OUT', -> saida de ted
-
ACCOUNT_STATUS_CHANGE = 'ACCOUNT-STATUS-CHANGE', -> mudança de status no onboarding da conta
-
CHARGE_SETTLEMENT = 'CHARGE-SETTLEMENT', -> liquidação do boleto
-
CHARGE_CREATE = 'CHARGE-CREATE', -> criação do boleto
-
CHARGE_CANCELATION = 'CHARGE-CANCELATION', -> cancelamento / expiração de um boleto
-
-
url(string, obrigatório): A URL a ser cadastrada para o envio dos webhooks.
Resposta
Se a requisição for processada com sucesso será retornado um código 200 e um ID do webhook configurada:
id(string/uuid): ID do webhook cadastrada.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Esse endpoint permite o cadastro de uma configuração para um webhook. É possivel cadastrar o recebimento de webhooks de cada entidade para cada conta escrow.
Os webhooks podem ser configurados de maneira distintas para cada ambiente (homologação/sandbox e produção).
Parâmetros da URL
account_id(string): ID de cadastro da conta a ser configurada.
Parâmetros da Requisição
-
webhookType(string, obrigatório): O tipo do webhook a ser cadastrado. Possíveis valores aceitos:-
SLC_PAYMENT_IN = 'SLC-PAYMENT-IN', -> entrada de SLC
-
PIX_PAYMENT_IN = 'PIX-PAYMENT-IN', -> entrada de pix
-
PIX_PAYMENT_OUT = 'PIX-PAYMENT-OUT', -> saida de pix
-
SPB_TRANSFER_IN = 'SPB-TRANSFER-IN', -> entrada de ted
-
SPB_TRANSFER_OUT = 'SPB-TRANSFER-OUT', -> saida de ted
-
ACCOUNT_STATUS_CHANGE = 'ACCOUNT-STATUS-CHANGE', -> mudança de status no onboarding da conta
-
CHARGE_SETTLEMENT = 'CHARGE-SETTLEMENT', -> liquidação do boleto
-
CHARGE_CREATE = 'CHARGE-CREATE', -> criação do boleto
-
CHARGE_CANCELATION = 'CHARGE-CANCELATION', -> cancelamento / expiração de um boleto
-
-
url(string, obrigatório): A URL a ser cadastrada para o envio dos webhooks.
Resposta
Se a requisição for processada com sucesso será retornado um código 200 e um ID do webhook configurada:
id(string/uuid): ID do webhook cadastrada.
Webhooks disparados
PIX-PAYMENT-IN
Evento disparado para recebimentos Pix. (Via chave ou Cobrança)
Campos:
- clientCode: ID da transação no BaaS
- amount: Valor recebido
- movementType: pix-payment-in
- senderDocument: Documento do Pagador
- senderName: Nome do Pagador
- pixChargeId: ID da Cobrança Pix (caso seja cobrança, caso contrário não volta o campo)
PIX-PAYMENT-OUT
Evento disparado para pagamentos Pix. (Postings)
Campos:
- id: UUID do Webhook
- clientCode: UUID do POSTING
- amount: Valor recebido
- movementType: pix-payment-out
- destinationDocument: Documento do Recebedor
- destinationName: Nome do Recebedor
BOLETO LIQUIDADO
"id": "f63acdb9-048e-4263-bda6-4e4ecd751366",
"chargeId": "f2fa238a-c050-4694-a4ff-dfc358288fdd",
"settlementDate": "2025-02-03 07:30:46.953 -0300",
"pixCode": "código pix",
"barCode": "código de barras",
"payedAmount": "valor pago",
"paymentMethod": "PIX | BOLETO",