{
"webhook_type": "payment_request.created",
"object_type": "payment_request",
"organization_id": "00000000-0000-4000-8000-000000000001",
"payment_request": {
"nozle_id": "00000000-0000-4000-8000-000000000002",
"amount_cents": 330,
"amount_currency": "USD",
"email": "jane@example.com",
"payment_status": "pending",
"automatic": false,
"created_at": "2026-10-13T00:20:30Z",
"customer": {
"nozle_id": "00000000-0000-4000-8000-000000000003",
"billing_entity_code": "pullse_testing",
"external_id": "vfy-rest-c1",
"account_type": "customer",
"name": "upd",
"firstname": null,
"lastname": null,
"customer_type": null,
"sequential_id": 389,
"slug": "PUL-CDDE-389",
"created_at": "2026-10-13T00:16:44Z",
"updated_at": "2026-10-13T00:23:11Z",
"country": "US",
"address_line1": null,
"address_line2": null,
"state": null,
"zipcode": null,
"email": "jane@example.com",
"city": null,
"url": null,
"phone": null,
"logo_url": null,
"legal_name": null,
"legal_number": null,
"currency": "USD",
"tax_identification_number": null,
"timezone": null,
"applicable_timezone": "Asia/Kolkata",
"net_payment_term": null,
"external_salesforce_id": null,
"finalize_zero_amount_invoice": "inherit",
"billing_configuration": {
"invoice_grace_period": 0,
"payment_provider": null,
"payment_provider_code": null,
"document_locale": "en",
"subscription_invoice_issuing_date_anchor": null,
"subscription_invoice_issuing_date_adjustment": null
},
"shipping_address": {
"address_line1": null,
"address_line2": null,
"city": null,
"zipcode": null,
"state": null,
"country": null
},
"skip_invoice_custom_sections": false,
"metadata": [
{
"nozle_id": "00000000-0000-4000-8000-000000000004",
"key": "vfy",
"value": "2",
"display_in_invoice": true,
"created_at": "2026-10-13T00:16:44Z"
}
]
},
"invoices": [
{
"nozle_id": "00000000-0000-4000-8000-000000000005",
"billing_entity_code": "pullse_testing",
"sequential_id": 3,
"number": "PUL-CDDE-202610-346",
"issuing_date": "2026-10-13",
"payment_due_date": "2026-10-10",
"net_payment_term": 0,
"invoice_type": "one_off",
"status": "finalized",
"payment_status": "pending",
"payment_dispute_lost_at": "2026-10-13T00:22:22.806Z",
"payment_overdue": false,
"currency": "USD",
"fees_amount_cents": 300,
"taxes_amount_cents": 30,
"progressive_billing_credit_amount_cents": 0,
"coupons_amount_cents": 0,
"credit_notes_amount_cents": 0,
"sub_total_excluding_taxes_amount_cents": 300,
"sub_total_including_taxes_amount_cents": 330,
"total_amount_cents": 330,
"total_due_amount_cents": 330,
"total_paid_amount_cents": 0,
"total_offsetted_credit_note_amount_cents": 0,
"prepaid_credit_amount_cents": 0,
"prepaid_granted_credit_amount_cents": null,
"prepaid_purchased_credit_amount_cents": null,
"file_url": null,
"xml_url": null,
"version_number": 4,
"self_billed": false,
"created_at": "2026-10-13T00:20:25Z",
"updated_at": "2026-10-13T00:22:22Z",
"voided_at": null
}
]
}
}Payments
An new payment request has been created
A payment request is created, by dunning or automatically for an invoice that Core did not charge (automatic is true).
WEBHOOK
payment_request_created
{
"webhook_type": "payment_request.created",
"object_type": "payment_request",
"organization_id": "00000000-0000-4000-8000-000000000001",
"payment_request": {
"nozle_id": "00000000-0000-4000-8000-000000000002",
"amount_cents": 330,
"amount_currency": "USD",
"email": "jane@example.com",
"payment_status": "pending",
"automatic": false,
"created_at": "2026-10-13T00:20:30Z",
"customer": {
"nozle_id": "00000000-0000-4000-8000-000000000003",
"billing_entity_code": "pullse_testing",
"external_id": "vfy-rest-c1",
"account_type": "customer",
"name": "upd",
"firstname": null,
"lastname": null,
"customer_type": null,
"sequential_id": 389,
"slug": "PUL-CDDE-389",
"created_at": "2026-10-13T00:16:44Z",
"updated_at": "2026-10-13T00:23:11Z",
"country": "US",
"address_line1": null,
"address_line2": null,
"state": null,
"zipcode": null,
"email": "jane@example.com",
"city": null,
"url": null,
"phone": null,
"logo_url": null,
"legal_name": null,
"legal_number": null,
"currency": "USD",
"tax_identification_number": null,
"timezone": null,
"applicable_timezone": "Asia/Kolkata",
"net_payment_term": null,
"external_salesforce_id": null,
"finalize_zero_amount_invoice": "inherit",
"billing_configuration": {
"invoice_grace_period": 0,
"payment_provider": null,
"payment_provider_code": null,
"document_locale": "en",
"subscription_invoice_issuing_date_anchor": null,
"subscription_invoice_issuing_date_adjustment": null
},
"shipping_address": {
"address_line1": null,
"address_line2": null,
"city": null,
"zipcode": null,
"state": null,
"country": null
},
"skip_invoice_custom_sections": false,
"metadata": [
{
"nozle_id": "00000000-0000-4000-8000-000000000004",
"key": "vfy",
"value": "2",
"display_in_invoice": true,
"created_at": "2026-10-13T00:16:44Z"
}
]
},
"invoices": [
{
"nozle_id": "00000000-0000-4000-8000-000000000005",
"billing_entity_code": "pullse_testing",
"sequential_id": 3,
"number": "PUL-CDDE-202610-346",
"issuing_date": "2026-10-13",
"payment_due_date": "2026-10-10",
"net_payment_term": 0,
"invoice_type": "one_off",
"status": "finalized",
"payment_status": "pending",
"payment_dispute_lost_at": "2026-10-13T00:22:22.806Z",
"payment_overdue": false,
"currency": "USD",
"fees_amount_cents": 300,
"taxes_amount_cents": 30,
"progressive_billing_credit_amount_cents": 0,
"coupons_amount_cents": 0,
"credit_notes_amount_cents": 0,
"sub_total_excluding_taxes_amount_cents": 300,
"sub_total_including_taxes_amount_cents": 330,
"total_amount_cents": 330,
"total_due_amount_cents": 330,
"total_paid_amount_cents": 0,
"total_offsetted_credit_note_amount_cents": 0,
"prepaid_credit_amount_cents": 0,
"prepaid_granted_credit_amount_cents": null,
"prepaid_purchased_credit_amount_cents": null,
"file_url": null,
"xml_url": null,
"version_number": 4,
"self_billed": false,
"created_at": "2026-10-13T00:20:25Z",
"updated_at": "2026-10-13T00:22:22Z",
"voided_at": null
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Signature of the webhook payload
Example:
"Ap¶5ɿΣ6ÐfV£Ä\u0015\u0015ºõÔõÔ[DæAâÿüÚ"
Algorithm used to generate the signature
Available options:
jwt, hmac Example:
"hmac"
Unique id of the webhook. It can be used for idempotency
Example:
"1a901a90-1a90-1a90-1a90-1a901a901a90"
Body
application/json
Details of the new payment request
Available options:
payment_request.created Available options:
payment_request Unique identifier of the organization, created by Nozle.
Example:
"1a901a90-1a90-1a90-1a90-1a901a901a90"
Show child attributes
Show child attributes
Response
200
Return a 2xx status within 30 seconds to acknowledge the delivery. Any other status, a timeout or a connection error is a failed attempt; Nozle makes up to 3 attempts.