Outgoing Webhooks

Headers

webhook-id

string

required

Unique identifier for the webhook

webhook-signature

string

required

Signature of the Webhook

webhook-timestamp

string

required

Unix timestamp when the webhook was sent

Body

application/json

business_id

string

required

data

object

required

data.business_id

string

required

Identifier of the business associated with the payment

data.created_at

string

required

Timestamp when the payment was created

data.currency

enum<string>

required

Available options:

AED,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SZL,

THB,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

data.customer

object

required

data.disputes

object[]

required

List of disputes associated with this payment

data.metadata

object

required

data.payment_id

string

required

Unique identifier for the payment

data.refunds

object[]

required

List of refunds issued for this payment

data.total_amount

integer

required

Total amount charged to the customer including tax, in smallest currency unit (e.g. cents)

data.payload_type

enum<string>

required

Available options:

Payment

data.discount_id

string | null

The discount id if discount is applied

data.error_message

string | null

An error message if the payment failed

data.payment_link

string | null

Checkout URL

data.payment_method

string | null

Payment method used by customer (e.g. "card", "bank_transfer")

data.payment_method_type

string | null

Specific type of payment method (e.g. "visa", "mastercard")

data.product_cart

object[] | null

List of products purchased in a one-time payment

data.status

enum<string>

Available options:

succeeded,

failed,

cancelled,

processing,

requires_customer_action,

requires_merchant_action,

requires_payment_method,

requires_confirmation,

requires_capture,

partially_captured,

partially_captured_and_capturable

data.subscription_id

string | null

Identifier of the subscription if payment is part of a subscription

data.tax

integer | null

Amount of tax collected in smallest currency unit (e.g. cents)

data.updated_at

string | null

Timestamp when the payment was last updated

timestamp

string

required

The timestamp of when the event occurred (not necessarily the same of when it was delivered)

type

enum<string>

required

Event types for Dodo events

Available options:

payment.succeeded,

payment.failed,

payment.processing,

payment.cancelled,

refund.succeeded,

refund.failed,

dispute.opened,

dispute.expired,

dispute.accepted,

dispute.cancelled,

dispute.challenged,

dispute.won,

dispute.lost,

subscription.active,

subscription.renewed,

subscription.on_hold,

subscription.paused,

subscription.cancelled,

subscription.failed,

subscription.expired,

license_key.created

API Documentation & SDKs

Payments

Subscriptions

Discounts

Licenses

Customers

Webhooks

Products

Refunds

Disputes

Payouts

Miscellaneous

Headers

Body