YODL Documentation
  • Introduction
  • Integration Guide
  • Audits
  • Smart Contracts
  • API
    • API Endpoints
    • Webhooks
    • Web3 ID Resolution
Powered by GitBook
On this page
  1. API

Webhooks

PreviousAPI EndpointsNextWeb3 ID Resolution

Last updated 1 year ago

For a high-level overview on how to integrate these API endpoints see Integration Guide.

This webhook specification needs to be implemented by the merchant backend. Upon payment confirmation and/or probabilistic finality the YODL.me backend calls this webhook. The backend has to query the YODL API for the complete transaction data to verify payment parameters and finalize the order.

The Webhook URL needs to be registered on the merchants YODL.me account.

Callback after payment was created or updated

POST https://WEBHOOK_URL/

YODL.me backend triggers this webhook whenever a payment was created and a processing/finality status has changed.

Payment data needs to be fetched through

Request Body

Name
Type
Description

chainId*

String

txHash*

String

state*

String

Finality state of transaction

#return-dev-readable-payment-data.