v1
latestOpenAPI 3.0.12026-07-245303882.5 MBContas > Webhook
Listar todos os webhooks cadastrados para uma Conta
Esse endpoint permite a listagem de todos os webhooks que estão configurados para uma determinada conta escrow.
Parâmetros da URL
- account_id (string): ID de cadastro da conta a ser configurada.
Resposta
Se a requisição for processada com sucesso será retornado um código 200 e um JSON com uma lista de webhooks no seguinte formato:
-
id (string/uuid): ID do webhook cadastrado.
-
status (string): Status do webhook. Possíveis valores: 'ACTIVE', 'REMOVED'
-
createdAt (datetime): Data e hora que foi realizado o cadastro do webhook.
-
webhookType (string, obrigatório): O tipo do webhook a ser cadastrado. Possíveis valores aceitos:
-
'SLC-PAYMENT-IN'
-
'SPB-TRANSFER-IN'
-
'SPB-TRANSFER-OUT'
-
'PIX-PAYMENT-IN'
-
'PIX-PAYMENT-OUT'
-
'ACCOUNT-STATUS-CHANGE'
-
-
url (string, obrigatório): A URL a ser cadastrada para o envio dos webhooks.
get/escrow/api/v1/accounts/{account_id}/webhook-configurations
Path parameters
account_idstring required
Headers
Acceptstring
Response
OK
object required