Webhooks Overview

What is a webhook

Webhooks enable apps to provide real-time information whenever an event happens without needing constant requests. They are a passive method to receive data between two systems through an HTTP POST. After configuring the Yuno webhooks, you will receive event notifications every time an activity or a function is generated within the Yuno flow.

Why do we recommend you use webhooks?

Webhooks are the best way to ensure your system is up-to-date with payment progress and status. Since the event notifications trigger automatically, your system won't need to perform recurrent requests to Yuno. You will process the payment information on demand.

What do you need to know before start using webhooks?

To start using Yuno’s webhooks, you need to build a public REST API to receive event notifications (POST request). That means the REST API you will build should not require any authentication or access restriction through a header. Despite using a public API, the communication system is very safe since Yuno event notifications will not be available to the public and will use a unique URL to communicate only to your REST API.

Webhooks delivery and response requirements

Yuno webhooks expects to receive an HTTP 200 OK status as a response to confirm the webhook was successfully received. The merchant system does not need to include any information in the response's body. Only the HTTP 200 status is required.

If no response is received within the specified time, Yuno will retry sending the event notification up to seven times to ensure no information is lost. Refer to the Receipt Confirmation Process section for details on the notification schedule and confirmation waiting times for each retry.

Banking Connectivity webhook events

Banking Connectivity (Banking as a Service) webhook notifications follow the same delivery and retry behavior described above. Yuno sends these events to your configured webhook endpoint when the status of a Banking Connectivity resource changes.

For incoming transfer payload structure, see Webhook Notifications (Banking Connectivity). Incoming transfer notifications are sent to your endpoint at {merchant_base_URL}/v1/banking/transfers.

Entity events

EventDescription
banking.entity.createdEntity created
banking.entity.updatedEntity updated
banking.entity.deletedEntity deleted

Onboarding events

EventDescription
banking.onboarding.createdOnboarding created
banking.onboarding.pendingSubmitted, awaiting review
banking.onboarding.pending_additional_documentationMore documents required
banking.onboarding.succeededOnboarding approved
banking.onboarding.failedOnboarding failed
banking.onboarding.declinedProvider declined
banking.onboarding.cancelledMerchant cancelled
banking.onboarding.expiredOnboarding expired

Account events

EventDescription
banking.account.createdAccount created
banking.account.updatedAccount updated
banking.account.activatedAccount activated
banking.account.closedAccount closed

Transfer events (outgoing)

EventDescription
banking.transfer.pendingTransfer pending
banking.transfer.processingTransfer processing
banking.transfer.completedTransfer completed
banking.transfer.failedTransfer failed
banking.transfer.cancelledTransfer cancelled
banking.transfer.reversedTransfer reversed

Transfer events (incoming)

EventDescription
banking.transfer.incoming.pendingIncoming transfer pending settlement
banking.transfer.incoming.completedIncoming transfer settled

Marketplace Split Transfer events

EventDescription
split_transfer.createdSplit transfer created
split_transfer.succeededSplit transfer succeeded
split_transfer.failedSplit transfer failed
split_transfer_reverse.createdSplit transfer reversal created
split_transfer_reverse.succeededSplit transfer reversal succeeded
split_transfer_reverse.failedSplit transfer reversal failed