{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/fincore/sidebars.yaml","api-docs-products/fincore/fincore-openapi.yaml":"api-docs-products/fincore/fincore-openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["json-schema","openapi-code-sample","openapi-response-sample","json-example"]},"type":"markdown"},"seo":{"title":"Webhooks","siteUrl":"https://docs.monato.com"},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"webhooks","__idx":0},"children":["Webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Webhooks notify your system about asynchronous events such as Money In,"," ","transaction status updates, CEP results, and report availability."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide includes the webhook configuration and event contracts."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"webhook-flow","__idx":1},"children":["Webhook flow"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Step"},"children":["Step"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Action"},"children":["Action"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"OpenAPI contract"},"children":["OpenAPI contract"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure a webhook URL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-webhook-configuration"},"children":["Create webhook configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List configured webhooks"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#list-webhook-configurations"},"children":["List webhook configurations"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve one webhook"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#retrieve-webhook-configuration"},"children":["Retrieve webhook configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["4"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update a webhook"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#update-webhook-configuration"},"children":["Update webhook configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["5"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete a webhook"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#delete-webhook-configuration"},"children":["Delete webhook configuration"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"event-contracts","__idx":2},"children":["Event contracts"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event"},"children":["Event"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use"},"children":["Use"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"OpenAPI contract"},"children":["OpenAPI contract"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Money In"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Incoming SPEI or internal credit."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/fincore/guides/money-in#money-in-webhook-event"},"children":["Money In webhook event"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Status update"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Money Out status changes."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#status-update-webhook-event"},"children":["Status update webhook event"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CEP"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Penny Validation result. Status values and transitions are documented in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/fincore/guides/cep-statuses"},"children":["CEP Statuses"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#cep-webhook-event"},"children":["CEP webhook event"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Refund"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A refund transaction was created."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#refund-webhook-event"},"children":["Refund webhook event"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Report"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generated report file available."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/fincore/guides/reports#report-webhook-event"},"children":["Report webhook event"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delivery-response-expectations","__idx":3},"children":["Delivery response expectations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-timeout","__idx":4},"children":["Response timeout"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your endpoint must return its HTTP response within ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["5 seconds"]}," of receiving a"," ","webhook request. This maximum response time applies to Money In, status update,"," ","CEP, refund, and report webhooks."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Complete the validations required to accept or reject the event within this"," ","window. Before acknowledging acceptance, persist the event safely; then perform"," ","any remaining processing asynchronously. For external Money In, make the"," ","acceptance or rejection decision before responding, as described in the"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/fincore/guides/money-in#accept-or-reject-a-money-in"},"children":["Money In guide"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Your response"},"children":["Your response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Event received."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["422"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Event received but rejected by your business validation. For external Money In, this can trigger refund behavior."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"security-notes","__idx":5},"children":["Security notes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Store webhook secrets securely. Do not expose them in logs or frontend code."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Validate the event type and message identifier before processing. Use the message"," ","identifier for deduplication."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-contracts","__idx":6},"children":["API contracts"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-webhook-configuration","__idx":7},"children":["Create webhook configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Endpoint: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/clients/{clientId}/webhooks"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"headers","__idx":8},"children":["Headers"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"path-parameters","__idx":9},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","description":"Client UUID for which the webhook is being registered."}},"required":["clientId"]},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","description":"Client UUID for which the webhook is being registered."}},"required":["clientId"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body","__idx":10},"children":["Request body"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../fincore-openapi.yaml#/components/schemas/CreateWebhookRequest"},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/CreateWebhookRequest"},"WebhookType":{"type":"string","enum":["MONEY_IN","STATUS_UPDATE","CEP","REPORT","REFUND"],"example":"MONEY_IN"},"WebhookAuthType":{"type":"string","description":"Authentication mode for outbound webhook delivery.","enum":["AUTH","NO_AUTH","OAUTH"],"example":"AUTH"},"CreateWebhookRequest":{"type":"object","description":"Request to register a webhook endpoint for a client.","required":["client_id","url","token","webhook_type","auth_type"],"properties":{"client_id":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook configuration.","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"url":{"type":"string","format":"uri","description":"Public HTTPS URL where Monato sends webhook events.","example":"https://example.com/webhook"},"token":{"type":"string","description":"Secret sent by Monato in webhook delivery requests. Use a random value of at least 32 bytes.","example":"secretToken0123"},"webhook_type":{"description":"Type of event delivered to this webhook.","$ref":"#/components/schemas/WebhookType"},"auth_type":{"description":"Authentication mode used when Monato delivers webhook events.","$ref":"#/components/schemas/WebhookAuthType"}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example","__idx":11},"children":["Request example"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-products/fincore/fincore-openapi.yaml","operationId":"createClientWebhook","language":"Payload","parameters":{},"environments":{},"codeSamplesResolved":[{"lang":"json","title":"Payload application/json","source":"{\n  \"client_id\": \"c2d1d1e3-3340-4170-980e-e9269bbbc551\",\n  \"url\": \"https://example.com/webhook\",\n  \"token\": \"secretToken0123\",\n  \"webhook_type\": \"MONEY_IN\",\n  \"auth_type\": \"AUTH\"\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"200-response-body","__idx":12},"children":["200 response body"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../fincore-openapi.yaml#/components/schemas/WebhookResponse"},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/WebhookResponse"},"WebhookType":{"type":"string","enum":["MONEY_IN","STATUS_UPDATE","CEP","REPORT","REFUND"],"example":"MONEY_IN"},"WebhookStatus":{"type":"string","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"},"WebhookResponse":{"type":"object","description":"Webhook configuration registered for a client.","required":["id","clientId","url","webhookType","webhookStatus"],"properties":{"id":{"type":"string","format":"uuid","description":"Webhook configuration UUID.","example":"29806117-2b15-4682-87f0-350e6695fe91"},"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook.","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"url":{"type":"string","format":"uri","description":"Destination URL where Monato sends webhook events.","example":"https://example.com/webhook"},"token":{"type":"string","description":"Secret configured for webhook delivery.","example":"secretToken0123"},"webhookType":{"description":"Type of events delivered to this webhook.","$ref":"#/components/schemas/WebhookType"},"webhookStatus":{"description":"Current webhook lifecycle status.","$ref":"#/components/schemas/WebhookStatus"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the webhook configuration was created.","example":"2025-04-03 13:40:54.056794-06:00"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the webhook configuration was last updated.","example":"2025-04-03 13:40:54.056794-06:00"},"deletedAt":{"type":["null","string"],"description":"Timestamp when the webhook configuration was deleted, or null.","example":null},"blockedAt":{"type":["null","string"],"description":"Timestamp when the webhook configuration was blocked, or null.","example":null},"deletedBy":{"type":["null","string"],"description":"Identifier of the actor that deleted the webhook, or null.","example":null},"blockedBy":{"type":["null","string"],"description":"Identifier of the actor that blocked the webhook, or null.","example":null}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example","__idx":13},"children":["Response example"]},{"$$mdtype":"Tag","name":"OpenApiResponseSample","attributes":{"descriptionFile":"api-docs-products/fincore/fincore-openapi.yaml","operationId":"createClientWebhook","responseSamplesResolved":[{"lang":"json","title":"200 application/json","source":"{\n  \"id\": \"29806117-2b15-4682-87f0-350e6695fe91\",\n  \"clientId\": \"c2d1d1e3-3340-4170-980e-e9269bbbc551\",\n  \"url\": \"https://example.com/webhook\",\n  \"token\": \"secretToken0123\",\n  \"webhookType\": \"MONEY_IN\",\n  \"webhookStatus\": \"ACTIVE\",\n  \"createdAt\": \"2025-04-03 13:40:54.056794-06:00\",\n  \"updatedAt\": \"2025-04-03 13:40:54.056794-06:00\",\n  \"deletedAt\": null,\n  \"blockedAt\": null,\n  \"deletedBy\": null,\n  \"blockedBy\": null\n}"},{"lang":"json","title":"400 application/json","source":"{\n  \"code\": 9,\n  \"message\": \"API Error\",\n  \"details\": [\n    null\n  ]\n}"},{"lang":"json","title":"401 application/json","source":"{\n  \"code\": 16,\n  \"message\": \"API Error\",\n  \"details\": [\n    {\n      \"reason\": \"UNAUTHORIZED\",\n      \"domain\": \"CORE\",\n      \"metadata\": {\n        \"error_detail\": \"Invalid Credentials\",\n        \"http_code\": \"401\"\n      }\n    }\n  ]\n}"},{"lang":"json","title":"500 application/json","source":"{\n  \"code\": 9,\n  \"message\": \"API Error\",\n  \"details\": [\n    null\n  ]\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error"},"children":["Error"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When it happens"},"children":["When it happens"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required webhook fields are missing or malformed, or a matching webhook configuration already exists."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The bearer token is missing, expired, invalid, or not valid for the environment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unexpected server error."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-webhook-configurations","__idx":14},"children":["List webhook configurations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Endpoint: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/clients/{clientId}/webhooks"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"headers-1","__idx":15},"children":["Headers"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"path-parameters-1","__idx":16},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhooks."}},"required":["clientId"]},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhooks."}},"required":["clientId"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-1","__idx":17},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No request body."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example-1","__idx":18},"children":["Request example"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-products/fincore/fincore-openapi.yaml","operationId":"listClientWebhooks","language":"Payload","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"200-response-body-1","__idx":19},"children":["200 response body"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../fincore-openapi.yaml#/components/schemas/WebhookListResponse"},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/WebhookListResponse"},"WebhookType":{"type":"string","enum":["MONEY_IN","STATUS_UPDATE","CEP","REPORT","REFUND"],"example":"MONEY_IN"},"WebhookStatus":{"type":"string","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"},"WebhookResponse":{"type":"object","description":"Webhook configuration registered for a client.","required":["id","clientId","url","webhookType","webhookStatus"],"properties":{"id":{"type":"string","format":"uuid","description":"Webhook configuration UUID.","example":"29806117-2b15-4682-87f0-350e6695fe91"},"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook.","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"url":{"type":"string","format":"uri","description":"Destination URL where Monato sends webhook events.","example":"https://example.com/webhook"},"token":{"type":"string","description":"Secret configured for webhook delivery.","example":"secretToken0123"},"webhookType":{"description":"Type of events delivered to this webhook.","$ref":"#/components/schemas/WebhookType"},"webhookStatus":{"description":"Current webhook lifecycle status.","$ref":"#/components/schemas/WebhookStatus"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the webhook configuration was created.","example":"2025-04-03 13:40:54.056794-06:00"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the webhook configuration was last updated.","example":"2025-04-03 13:40:54.056794-06:00"},"deletedAt":{"type":["null","string"],"description":"Timestamp when the webhook configuration was deleted, or null.","example":null},"blockedAt":{"type":["null","string"],"description":"Timestamp when the webhook configuration was blocked, or null.","example":null},"deletedBy":{"type":["null","string"],"description":"Identifier of the actor that deleted the webhook, or null.","example":null},"blockedBy":{"type":["null","string"],"description":"Identifier of the actor that blocked the webhook, or null.","example":null}}},"WebhookListResponse":{"type":"object","description":"Paginated list of webhook configurations.","properties":{"currentPage":{"type":"integer","description":"Current page number.","example":0},"perPage":{"type":"integer","description":"Number of webhook configurations returned per page.","example":50},"totalItem":{"type":"integer","description":"Total number of webhook configurations matching the request.","example":2},"data":{"type":"array","description":"Webhook configurations returned for the client.","items":{"$ref":"#/components/schemas/WebhookResponse"}}},"required":["currentPage","perPage","totalItem","data"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-1","__idx":20},"children":["Response example"]},{"$$mdtype":"Tag","name":"OpenApiResponseSample","attributes":{"descriptionFile":"api-docs-products/fincore/fincore-openapi.yaml","operationId":"listClientWebhooks","responseSamplesResolved":[{"lang":"json","title":"200 application/json","source":"{\n  \"currentPage\": 0,\n  \"perPage\": 50,\n  \"totalItem\": 2,\n  \"data\": [\n    null\n  ]\n}"},{"lang":"json","title":"400 application/json","source":"{\n  \"code\": 9,\n  \"message\": \"API Error\",\n  \"details\": [\n    null\n  ]\n}"},{"lang":"json","title":"401 application/json","source":"{\n  \"code\": 16,\n  \"message\": \"API Error\",\n  \"details\": [\n    {\n      \"reason\": \"UNAUTHORIZED\",\n      \"domain\": \"CORE\",\n      \"metadata\": {\n        \"error_detail\": \"Invalid Credentials\",\n        \"http_code\": \"401\"\n      }\n    }\n  ]\n}"},{"lang":"json","title":"500 application/json","source":"{\n  \"code\": 9,\n  \"message\": \"API Error\",\n  \"details\": [\n    null\n  ]\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error"},"children":["Error"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When it happens"},"children":["When it happens"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request parameters are malformed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The bearer token is missing, expired, invalid, or not valid for the environment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unexpected server error."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"retrieve-webhook-configuration","__idx":21},"children":["Retrieve webhook configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Endpoint: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/clients/{clientId}/webhooks/{webhookId}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"headers-2","__idx":22},"children":["Headers"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"path-parameters-2","__idx":23},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook."},"id":{"type":"string","format":"uuid","description":"Webhook UUID."}},"required":["clientId","id"]},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook."},"id":{"type":"string","format":"uuid","description":"Webhook UUID."}},"required":["clientId","id"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-2","__idx":24},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No request body."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example-2","__idx":25},"children":["Request example"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-products/fincore/fincore-openapi.yaml","operationId":"getClientWebhook","language":"Payload","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"200-response-body-2","__idx":26},"children":["200 response body"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../fincore-openapi.yaml#/components/schemas/WebhookResponse"},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/WebhookResponse"},"WebhookType":{"type":"string","enum":["MONEY_IN","STATUS_UPDATE","CEP","REPORT","REFUND"],"example":"MONEY_IN"},"WebhookStatus":{"type":"string","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"},"WebhookResponse":{"type":"object","description":"Webhook configuration registered for a client.","required":["id","clientId","url","webhookType","webhookStatus"],"properties":{"id":{"type":"string","format":"uuid","description":"Webhook configuration UUID.","example":"29806117-2b15-4682-87f0-350e6695fe91"},"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook.","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"url":{"type":"string","format":"uri","description":"Destination URL where Monato sends webhook events.","example":"https://example.com/webhook"},"token":{"type":"string","description":"Secret configured for webhook delivery.","example":"secretToken0123"},"webhookType":{"description":"Type of events delivered to this webhook.","$ref":"#/components/schemas/WebhookType"},"webhookStatus":{"description":"Current webhook lifecycle status.","$ref":"#/components/schemas/WebhookStatus"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the webhook configuration was created.","example":"2025-04-03 13:40:54.056794-06:00"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the webhook configuration was last updated.","example":"2025-04-03 13:40:54.056794-06:00"},"deletedAt":{"type":["null","string"],"description":"Timestamp when the webhook configuration was deleted, or null.","example":null},"blockedAt":{"type":["null","string"],"description":"Timestamp when the webhook configuration was blocked, or null.","example":null},"deletedBy":{"type":["null","string"],"description":"Identifier of the actor that deleted the webhook, or null.","example":null},"blockedBy":{"type":["null","string"],"description":"Identifier of the actor that blocked the webhook, or null.","example":null}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-2","__idx":27},"children":["Response example"]},{"$$mdtype":"Tag","name":"OpenApiResponseSample","attributes":{"descriptionFile":"api-docs-products/fincore/fincore-openapi.yaml","operationId":"getClientWebhook","responseSamplesResolved":[{"lang":"json","title":"200 application/json","source":"{\n  \"id\": \"29806117-2b15-4682-87f0-350e6695fe91\",\n  \"clientId\": \"c2d1d1e3-3340-4170-980e-e9269bbbc551\",\n  \"url\": \"https://example.com/webhook\",\n  \"token\": \"secretToken0123\",\n  \"webhookType\": \"MONEY_IN\",\n  \"webhookStatus\": \"ACTIVE\",\n  \"createdAt\": \"2025-04-03 13:40:54.056794-06:00\",\n  \"updatedAt\": \"2025-04-03 13:40:54.056794-06:00\",\n  \"deletedAt\": null,\n  \"blockedAt\": null,\n  \"deletedBy\": null,\n  \"blockedBy\": null\n}"},{"lang":"json","title":"401 application/json","source":"{\n  \"code\": 16,\n  \"message\": \"API Error\",\n  \"details\": [\n    {\n      \"reason\": \"UNAUTHORIZED\",\n      \"domain\": \"CORE\",\n      \"metadata\": {\n        \"error_detail\": \"Invalid Credentials\",\n        \"http_code\": \"401\"\n      }\n    }\n  ]\n}"},{"lang":"json","title":"404 application/json","source":"{\n  \"code\": 9,\n  \"message\": \"API Error\",\n  \"details\": [\n    null\n  ]\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error"},"children":["Error"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When it happens"},"children":["When it happens"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The bearer token is missing, expired, invalid, or not valid for the environment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The webhook configuration was not found for the supplied client."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"update-webhook-configuration","__idx":28},"children":["Update webhook configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Endpoint: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /v1/clients/{clientId}/webhooks/{webhookId}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"headers-3","__idx":29},"children":["Headers"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"path-parameters-3","__idx":30},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook."},"id":{"type":"string","format":"uuid","description":"Webhook UUID."}},"required":["clientId","id"]},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook."},"id":{"type":"string","format":"uuid","description":"Webhook UUID."}},"required":["clientId","id"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-3","__idx":31},"children":["Request body"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../fincore-openapi.yaml#/components/schemas/WebhookUpdateRequest"},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/WebhookUpdateRequest"},"WebhookStatus":{"type":"string","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"},"WebhookUpdateRequest":{"type":"object","description":"Fields available to update for an existing webhook. All fields are optional, but at least one must be provided.\n","properties":{"url":{"type":"string","format":"uri","description":"New delivery URL for the webhook.","example":"https://example.com/new-webhook"},"token":{"type":"string","description":"New secret used to authenticate webhook delivery.","example":"newTokenValue"},"webhook_status":{"description":"New webhook lifecycle status.","$ref":"#/components/schemas/WebhookStatus"},"auth_client_id":{"type":"string","description":"OAuth client identifier used when auth_type is OAUTH.","example":"oauth-client-id"},"auth_client_secret":{"type":"string","description":"OAuth client secret used when auth_type is OAUTH.","example":"oauth-client-secret"},"auth_url":{"type":"string","format":"uri","description":"OAuth token endpoint used for webhook delivery authentication.","example":"https://auth.example.com/oauth2/token"},"auth_scope":{"type":"string","description":"OAuth scopes requested for webhook delivery authentication.","example":"scope1 scope2"},"auth_audience":{"type":"string","description":"OAuth audience requested for webhook delivery authentication.","example":"https://api.example.com"}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example-3","__idx":32},"children":["Request example"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-products/fincore/fincore-openapi.yaml","operationId":"updateClientWebhook","language":"Payload","parameters":{},"environments":{},"codeSamplesResolved":[{"lang":"json","title":"Payload application/json","source":"{\n  \"url\": \"https://example.com/new-webhook\",\n  \"webhook_status\": \"ACTIVE\"\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"200-response-body-3","__idx":33},"children":["200 response body"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../fincore-openapi.yaml#/components/schemas/WebhookResponse"},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/WebhookResponse"},"WebhookType":{"type":"string","enum":["MONEY_IN","STATUS_UPDATE","CEP","REPORT","REFUND"],"example":"MONEY_IN"},"WebhookStatus":{"type":"string","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"},"WebhookResponse":{"type":"object","description":"Webhook configuration registered for a client.","required":["id","clientId","url","webhookType","webhookStatus"],"properties":{"id":{"type":"string","format":"uuid","description":"Webhook configuration UUID.","example":"29806117-2b15-4682-87f0-350e6695fe91"},"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook.","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"url":{"type":"string","format":"uri","description":"Destination URL where Monato sends webhook events.","example":"https://example.com/webhook"},"token":{"type":"string","description":"Secret configured for webhook delivery.","example":"secretToken0123"},"webhookType":{"description":"Type of events delivered to this webhook.","$ref":"#/components/schemas/WebhookType"},"webhookStatus":{"description":"Current webhook lifecycle status.","$ref":"#/components/schemas/WebhookStatus"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the webhook configuration was created.","example":"2025-04-03 13:40:54.056794-06:00"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the webhook configuration was last updated.","example":"2025-04-03 13:40:54.056794-06:00"},"deletedAt":{"type":["null","string"],"description":"Timestamp when the webhook configuration was deleted, or null.","example":null},"blockedAt":{"type":["null","string"],"description":"Timestamp when the webhook configuration was blocked, or null.","example":null},"deletedBy":{"type":["null","string"],"description":"Identifier of the actor that deleted the webhook, or null.","example":null},"blockedBy":{"type":["null","string"],"description":"Identifier of the actor that blocked the webhook, or null.","example":null}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-3","__idx":34},"children":["Response example"]},{"$$mdtype":"Tag","name":"OpenApiResponseSample","attributes":{"descriptionFile":"api-docs-products/fincore/fincore-openapi.yaml","operationId":"updateClientWebhook","responseSamplesResolved":[{"lang":"json","title":"200 application/json","source":"{\n  \"id\": \"29806117-2b15-4682-87f0-350e6695fe91\",\n  \"clientId\": \"c2d1d1e3-3340-4170-980e-e9269bbbc551\",\n  \"url\": \"https://example.com/webhook\",\n  \"token\": \"secretToken0123\",\n  \"webhookType\": \"MONEY_IN\",\n  \"webhookStatus\": \"ACTIVE\",\n  \"createdAt\": \"2025-04-03 13:40:54.056794-06:00\",\n  \"updatedAt\": \"2025-04-03 13:40:54.056794-06:00\",\n  \"deletedAt\": null,\n  \"blockedAt\": null,\n  \"deletedBy\": null,\n  \"blockedBy\": null\n}"},{"lang":"json","title":"400 application/json","source":"{\n  \"code\": 9,\n  \"message\": \"API Error\",\n  \"details\": [\n    null\n  ]\n}"},{"lang":"json","title":"401 application/json","source":"{\n  \"code\": 16,\n  \"message\": \"API Error\",\n  \"details\": [\n    {\n      \"reason\": \"UNAUTHORIZED\",\n      \"domain\": \"CORE\",\n      \"metadata\": {\n        \"error_detail\": \"Invalid Credentials\",\n        \"http_code\": \"401\"\n      }\n    }\n  ]\n}"},{"lang":"json","title":"404 application/json","source":"{\n  \"code\": 9,\n  \"message\": \"API Error\",\n  \"details\": [\n    null\n  ]\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error"},"children":["Error"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When it happens"},"children":["When it happens"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Webhook update fields are missing or malformed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The bearer token is missing, expired, invalid, or not valid for the environment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The webhook configuration was not found for the supplied client."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-webhook-configuration","__idx":35},"children":["Delete webhook configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Endpoint: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /v1/clients/{clientId}/webhooks/{webhookId}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"headers-4","__idx":36},"children":["Headers"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"path-parameters-4","__idx":37},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook."},"id":{"type":"string","format":"uuid","description":"Webhook UUID."}},"required":["clientId","id"]},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook."},"id":{"type":"string","format":"uuid","description":"Webhook UUID."}},"required":["clientId","id"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-4","__idx":38},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No request body."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example-4","__idx":39},"children":["Request example"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-products/fincore/fincore-openapi.yaml","operationId":"deleteClientWebhook","language":"Payload","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"200-response-body-4","__idx":40},"children":["200 response body"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../fincore-openapi.yaml#/components/schemas/WebhookResponse"},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/WebhookResponse"},"WebhookType":{"type":"string","enum":["MONEY_IN","STATUS_UPDATE","CEP","REPORT","REFUND"],"example":"MONEY_IN"},"WebhookStatus":{"type":"string","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"},"WebhookResponse":{"type":"object","description":"Webhook configuration registered for a client.","required":["id","clientId","url","webhookType","webhookStatus"],"properties":{"id":{"type":"string","format":"uuid","description":"Webhook configuration UUID.","example":"29806117-2b15-4682-87f0-350e6695fe91"},"clientId":{"type":"string","format":"uuid","description":"Client UUID that owns the webhook.","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"url":{"type":"string","format":"uri","description":"Destination URL where Monato sends webhook events.","example":"https://example.com/webhook"},"token":{"type":"string","description":"Secret configured for webhook delivery.","example":"secretToken0123"},"webhookType":{"description":"Type of events delivered to this webhook.","$ref":"#/components/schemas/WebhookType"},"webhookStatus":{"description":"Current webhook lifecycle status.","$ref":"#/components/schemas/WebhookStatus"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the webhook configuration was created.","example":"2025-04-03 13:40:54.056794-06:00"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the webhook configuration was last updated.","example":"2025-04-03 13:40:54.056794-06:00"},"deletedAt":{"type":["null","string"],"description":"Timestamp when the webhook configuration was deleted, or null.","example":null},"blockedAt":{"type":["null","string"],"description":"Timestamp when the webhook configuration was blocked, or null.","example":null},"deletedBy":{"type":["null","string"],"description":"Identifier of the actor that deleted the webhook, or null.","example":null},"blockedBy":{"type":["null","string"],"description":"Identifier of the actor that blocked the webhook, or null.","example":null}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-4","__idx":41},"children":["Response example"]},{"$$mdtype":"Tag","name":"OpenApiResponseSample","attributes":{"descriptionFile":"api-docs-products/fincore/fincore-openapi.yaml","operationId":"deleteClientWebhook","responseSamplesResolved":[{"lang":"json","title":"200 application/json","source":"{\n  \"id\": \"29806117-2b15-4682-87f0-350e6695fe91\",\n  \"clientId\": \"c2d1d1e3-3340-4170-980e-e9269bbbc551\",\n  \"url\": \"https://example.com/webhook\",\n  \"token\": \"secretToken0123\",\n  \"webhookType\": \"MONEY_IN\",\n  \"webhookStatus\": \"ACTIVE\",\n  \"createdAt\": \"2025-04-03 13:40:54.056794-06:00\",\n  \"updatedAt\": \"2025-04-03 13:40:54.056794-06:00\",\n  \"deletedAt\": null,\n  \"blockedAt\": null,\n  \"deletedBy\": null,\n  \"blockedBy\": null\n}"},{"lang":"json","title":"401 application/json","source":"{\n  \"code\": 16,\n  \"message\": \"API Error\",\n  \"details\": [\n    {\n      \"reason\": \"UNAUTHORIZED\",\n      \"domain\": \"CORE\",\n      \"metadata\": {\n        \"error_detail\": \"Invalid Credentials\",\n        \"http_code\": \"401\"\n      }\n    }\n  ]\n}"},{"lang":"json","title":"404 application/json","source":"{\n  \"code\": 9,\n  \"message\": \"API Error\",\n  \"details\": [\n    null\n  ]\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error"},"children":["Error"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When it happens"},"children":["When it happens"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The bearer token is missing, expired, invalid, or not valid for the environment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The webhook configuration was not found for the supplied client."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"status-update-webhook-event","__idx":42},"children":["Status update webhook event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Webhook event: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST status-update"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"headers-5","__idx":43},"children":["Headers"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-5","__idx":44},"children":["Request body"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../fincore-openapi.yaml#/components/schemas/StatusUpdateMessage"},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/StatusUpdateMessage"},"TransactionStatus":{"type":"string","enum":["INITIALIZED","IN_PROGRESS","LIQUIDATED","CANCELLED","REFUNDED","REJECTED","DECLINED"],"example":"INITIALIZED"},"StatusUpdateMessage":{"type":"object","description":"Webhook event sent when a transaction status changes.","required":["id_msg","msg_name","msg_date","body"],"properties":{"id_msg":{"type":"string","format":"uuid","description":"Unique message identifier for deduplication.","example":"35066b9c-e1e3-4d1b-89e6-35c036a70b00"},"msg_name":{"type":"string","enum":["STATUS_UPDATE"],"description":"Event name. For status notifications it is always STATUS_UPDATE.","example":"STATUS_UPDATE"},"msg_date":{"type":"string","format":"date","description":"Event date in YYYY-MM-DD format.","example":"2025-08-27"},"body":{"type":"object","description":"Transaction status update payload.","properties":{"id":{"type":"string","format":"uuid","description":"Transaction UUID.","example":"6fd78718-106c-485d-824d-f6c3e8133571"},"tracking_key":{"type":"string","description":"Transaction tracking key for reconciliation.","example":"20250827FINCH5CJS56XDFE"},"message_type":{"type":"string","description":"Rail or message type associated with the status update.","example":"SPEI"},"reason":{"type":"string","description":"Machine-readable reason for the status update when available.","example":"CANCELLED_ACCOUNT"},"reason_description":{"type":"string","description":"Human-readable reason for the status update when available.","example":"Cuenta cancelada"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"update_at":{"type":"string","format":"date-time","description":"Timestamp when the status update was generated.","example":"2025-08-27T15:40:44.413078-06:00"}}}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example-5","__idx":45},"children":["Request example"]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"id_msg":"35066b9c-e1e3-4d1b-89e6-35c036a70b00","msg_name":"STATUS_UPDATE","msg_date":"2025-08-27","body":{"id":"6fd78718-106c-485d-824d-f6c3e8133571","tracking_key":"20250827FINCH5CJS56XDFE","message_type":"SPEI","reason":"CANCELLED_ACCOUNT","reason_description":"Cuenta cancelada","status":"INITIALIZED","update_at":"2025-08-27T15:40:44.413078-06:00"}},"errors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"200-response-body-5","__idx":46},"children":["200 response body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No response body."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-5","__idx":47},"children":["Response example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No response body for successful acknowledgements."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error"},"children":["Error"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When it happens"},"children":["When it happens"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["422"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your system received the event but could not process it as valid."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"cep-webhook-event","__idx":48},"children":["CEP webhook event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Webhook event: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST cep"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This event is emitted on every CEP status change except ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INITIALIZED"]},", so a"," ","single validation can produce several events before reaching ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPLETED"]}," or"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FAILED"]},". See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/fincore/guides/cep-statuses"},"children":["CEP Statuses"]}," for the full lifecycle and the"," ","transitions between statuses."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"headers-6","__idx":49},"children":["Headers"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-6","__idx":50},"children":["Request body"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../fincore-openapi.yaml#/components/schemas/WebhookCepEvent"},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/WebhookCepEvent"},"WebhookCepEvent":{"type":"object","properties":{"id_msg":{"type":"string","format":"uuid","description":"Unique message identifier (use for idempotency/deduplication)","example":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"},"msg_name":{"type":"string","description":"Event name","enum":["CEP"],"example":"CEP"},"msg_date":{"type":"string","format":"date","description":"Event date (YYYY-MM-DD)","example":"2025-08-15"},"body":{"type":"object","description":"CEP update payload.","properties":{"id":{"type":"string","format":"uuid","description":"Transaction ID for the penny validation","example":"11111111-2222-3333-4444-555555555555"},"tracking_key":{"type":"string","example":"20250815XXXXXX123456789"},"beneficiary_account":{"type":"string","description":"CLABE of the beneficiary","example":"000000000000000000"},"beneficiary_name":{"type":"string","example":"Daniela Paola Santelices Chavez"},"beneficiary_rfc":{"type":["string","null"],"example":"XXXX000000XXX"},"status":{"type":"string","description":"CEP processing status","enum":["PENDING","DELAYED","COMPLETED","FAILED"],"example":"DELAYED"},"processed_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when CEP was finalized (COMPLETED/FAILED)","example":"2025-08-15T22:42:39.327Z"}}}},"required":["id_msg","msg_name","msg_date","body"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example-6","__idx":51},"children":["Request example"]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"id_msg":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","msg_name":"CEP","msg_date":"2025-08-15","body":{"id":"11111111-2222-3333-4444-555555555555","tracking_key":"20250815XXXXXX123456789","beneficiary_account":"000000000000000000","beneficiary_name":"Daniela Paola Santelices Chavez","beneficiary_rfc":"XXXX000000XXX","status":"DELAYED","processed_at":"2025-08-15T22:42:39.327Z"}},"errors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"200-response-body-6","__idx":52},"children":["200 response body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No response body."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-6","__idx":53},"children":["Response example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No response body for successful acknowledgements."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error"},"children":["Error"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When it happens"},"children":["When it happens"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["422"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your system received the event but could not process it as valid."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"refund-webhook-event","__idx":54},"children":["Refund webhook event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Webhook event: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST refund"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Monato sends this event when a refund transaction is created. There are two"," ","cases, and the second one is not triggered by you:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You call the refund endpoint for a Money In."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An outbound SPEI transfer is reversed by the banking network."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Register this webhook if you need to reconcile reversals you did not initiate."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["body"]}," describes the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["refund transaction"]},", not the original one. Use"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["original_transaction_id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["original_transaction_tracking_id"]}," to link it back"," ","to the transaction being refunded. Partial refunds are not supported, so"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," always equals ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["original_transaction_amount"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"headers-7","__idx":55},"children":["Headers"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"type":"object","required":["Authorization"],"properties":{"Authorization":{"type":"string","description":"Bearer token returned by the authentication flow.","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-7","__idx":56},"children":["Request body"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../fincore-openapi.yaml#/components/schemas/WebhookRefundEvent"},"options":{"hideSchemaTitles":true,"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/WebhookRefundEvent"},"WebhookRefundEvent":{"type":"object","description":"Webhook event sent when a refund transaction is created.","required":["id_msg","msg_name","msg_date","body"],"properties":{"id_msg":{"type":"string","format":"uuid","description":"Unique message identifier (use for idempotency/deduplication)","example":"f0b1c6de-6a3c-4f2e-9d47-1c0a5b7e2d38"},"msg_name":{"type":"string","enum":["REFUND"],"description":"Event name. For refund notifications it is always REFUND.","example":"REFUND"},"msg_date":{"type":"string","format":"date","description":"Event date (YYYY-MM-DD)","example":"2026-09-21"},"body":{"type":"object","description":"Refund transaction payload.","properties":{"id":{"type":"string","format":"uuid","description":"Transaction ID of the refund itself, not of the original transaction.","example":"0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0"},"tracking_key":{"type":"string","description":"Tracking key of the refund transaction.","example":"20260921FINCHXXXXQ6RPX4"},"beneficiary_account":{"type":"string","description":"CLABE receiving the refunded funds.","example":"734180000000001004"},"beneficiary_name":{"type":"string","example":"Carolina Perez Marquez"},"beneficiary_rfc":{"type":["string","null"],"example":"XAXX010101000"},"payer_account":{"type":"string","description":"CLABE the refund is sent from.","example":"734185000000000055"},"payer_name":{"type":"string","example":"FINCO PAY"},"payer_rfc":{"type":["string","null"],"example":"XAXX010101000"},"payer_institution":{"type":"string","description":"Institution code of the payer.","example":"90734"},"amount":{"type":"string","description":"Refunded amount. Partial refunds are not supported, so this equals the original amount.","example":"150.00"},"transaction_date":{"type":"string","description":"Creation timestamp of the refund transaction.","example":"2026-09-21 13:03:36"},"category":{"type":"string","example":"CREDIT_TRANS"},"sub_category":{"type":"string","example":"SPEI_REFUNDED_CREDIT"},"payment_concept":{"type":"string","description":"Description of the refund.","example":"Refund due to incorrect amount"},"numeric_reference":{"type":["string","null"],"description":"Numeric reference of the refund transaction.","example":"1234567"},"original_transaction_id":{"type":"string","format":"uuid","description":"Transaction ID of the original transaction being refunded.","example":"1eb4b5ac-71f6-4203-aded-4fcb7fd21637"},"original_transaction_tracking_id":{"type":"string","description":"Tracking key of the original transaction being refunded.","example":"20260920FINCHZ43V14QILB"},"original_transaction_amount":{"type":"string","description":"Amount of the original transaction.","example":"150.00"}}}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example-7","__idx":57},"children":["Request example"]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"id_msg":"f0b1c6de-6a3c-4f2e-9d47-1c0a5b7e2d38","msg_name":"REFUND","msg_date":"2026-09-21","body":{"id":"0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0","tracking_key":"20260921FINCHXXXXQ6RPX4","beneficiary_account":"734180000000001004","beneficiary_name":"Carolina Perez Marquez","beneficiary_rfc":"XAXX010101000","payer_account":"734185000000000055","payer_name":"FINCO PAY","payer_rfc":"XAXX010101000","payer_institution":"90734","amount":"150.00","transaction_date":"2026-09-21 13:03:36","category":"CREDIT_TRANS","sub_category":"SPEI_REFUNDED_CREDIT","payment_concept":"Refund due to incorrect amount","numeric_reference":"1234567","original_transaction_id":"1eb4b5ac-71f6-4203-aded-4fcb7fd21637","original_transaction_tracking_id":"20260920FINCHZ43V14QILB","original_transaction_amount":"150.00"}},"errors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"200-response-body-7","__idx":58},"children":["200 response body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No response body."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-7","__idx":59},"children":["Response example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No response body for successful acknowledgements."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error"},"children":["Error"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When it happens"},"children":["When it happens"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["422"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your system received the event but could not process it as valid."]}]}]}]}]}]},"headings":[{"value":"Webhooks","id":"webhooks","depth":1},{"value":"Webhook flow","id":"webhook-flow","depth":2},{"value":"Event contracts","id":"event-contracts","depth":2},{"value":"Delivery response expectations","id":"delivery-response-expectations","depth":2},{"value":"Response timeout","id":"response-timeout","depth":3},{"value":"Security notes","id":"security-notes","depth":2},{"value":"API contracts","id":"api-contracts","depth":2},{"value":"Create webhook configuration","id":"create-webhook-configuration","depth":3},{"value":"Headers","id":"headers","depth":4},{"value":"Path parameters","id":"path-parameters","depth":4},{"value":"Request body","id":"request-body","depth":4},{"value":"Request example","id":"request-example","depth":4},{"value":"200 response body","id":"200-response-body","depth":4},{"value":"Response example","id":"response-example","depth":4},{"value":"List webhook configurations","id":"list-webhook-configurations","depth":3},{"value":"Headers","id":"headers-1","depth":4},{"value":"Path parameters","id":"path-parameters-1","depth":4},{"value":"Request body","id":"request-body-1","depth":4},{"value":"Request example","id":"request-example-1","depth":4},{"value":"200 response body","id":"200-response-body-1","depth":4},{"value":"Response example","id":"response-example-1","depth":4},{"value":"Retrieve webhook configuration","id":"retrieve-webhook-configuration","depth":3},{"value":"Headers","id":"headers-2","depth":4},{"value":"Path parameters","id":"path-parameters-2","depth":4},{"value":"Request body","id":"request-body-2","depth":4},{"value":"Request example","id":"request-example-2","depth":4},{"value":"200 response body","id":"200-response-body-2","depth":4},{"value":"Response example","id":"response-example-2","depth":4},{"value":"Update webhook configuration","id":"update-webhook-configuration","depth":3},{"value":"Headers","id":"headers-3","depth":4},{"value":"Path parameters","id":"path-parameters-3","depth":4},{"value":"Request body","id":"request-body-3","depth":4},{"value":"Request example","id":"request-example-3","depth":4},{"value":"200 response body","id":"200-response-body-3","depth":4},{"value":"Response example","id":"response-example-3","depth":4},{"value":"Delete webhook configuration","id":"delete-webhook-configuration","depth":3},{"value":"Headers","id":"headers-4","depth":4},{"value":"Path parameters","id":"path-parameters-4","depth":4},{"value":"Request body","id":"request-body-4","depth":4},{"value":"Request example","id":"request-example-4","depth":4},{"value":"200 response body","id":"200-response-body-4","depth":4},{"value":"Response example","id":"response-example-4","depth":4},{"value":"Status update webhook event","id":"status-update-webhook-event","depth":3},{"value":"Headers","id":"headers-5","depth":4},{"value":"Request body","id":"request-body-5","depth":4},{"value":"Request example","id":"request-example-5","depth":4},{"value":"200 response body","id":"200-response-body-5","depth":4},{"value":"Response example","id":"response-example-5","depth":4},{"value":"CEP webhook event","id":"cep-webhook-event","depth":3},{"value":"Headers","id":"headers-6","depth":4},{"value":"Request body","id":"request-body-6","depth":4},{"value":"Request example","id":"request-example-6","depth":4},{"value":"200 response body","id":"200-response-body-6","depth":4},{"value":"Response example","id":"response-example-6","depth":4},{"value":"Refund webhook event","id":"refund-webhook-event","depth":3},{"value":"Headers","id":"headers-7","depth":4},{"value":"Request body","id":"request-body-7","depth":4},{"value":"Request example","id":"request-example-7","depth":4},{"value":"200 response body","id":"200-response-body-7","depth":4},{"value":"Response example","id":"response-example-7","depth":4}],"frontmatter":{"seo":{"title":"Webhooks"}},"lastModified":"2026-09-25T20:24:18.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/fincore/guides/webhooks","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}