Skip to main content

​
Event

payment.plan_created Sent only from:
  • Unified tokenized flows when a payment or payment plan is setup, with a tokenized payment process.
  • USAePay payment processing when a plan or payment is set up.
SCollect, eCollect, and other direct CRM integrations do not emit this event. As the plans go straight into their service. The HTTP body uses the standard webhook envelope: top-level event, eventCategory, organization, optional agent, timestamp, and payload — the object below is the payload value. Treat tokenized as sensitive (processor payment key / token). Use HTTPS, protect your signing secret, and avoid logging full bodies.

​
How payload is built

Cora merges normalized fields with plan-specific data. Optional passthrough when present: consumerId, currency, externalId, accountId, gateway, outcome.

​
Normalized and plan fields (inner payload)

FieldDescription
title"<Organization name> Payment Plan Created"
nameCustomer / payor name when provided
fileNumberAccount / file reference uploaded with
balanceBalance string when provided
callIdVoice / session id when provided (e.g. metadata runId)
tokenizedProcessor token / payment key when provided
paymentTypeInstrument hint: card, ach, or wallet (voice flows default to card)
totalAmountSum of scheduled payment amounts (string, two decimals)
paymentDateFirst scheduled payment date (YYYY-MM-DD)
numberOfInstallmentsLength of the payments array
amountPerInstallmentConfigured per-installment amount string
downPaymentDown payment from plan config (0.00 when none)
regularityweekly, biweekly, monthly, or one_time
planTypeOne of: settle_today, settlement_plan, regular_payment_plan, single_payment
paymentsArray of { paymentDate, amount, processed } — processed is true only for the first row when an immediate charge succeeded (e.g. tokenized paymentToday or USAePay plan success)
phoneNumberPhone when provided
agentNameAgent display name when provided

​
Example payload

{
  "title": "Acme Corp Payment Plan Created",
  "name": "Jane Smith",
  "fileNumber": "12345",
  "balance": "1250.00",
  "callId": "call_abc123",
  "tokenized": "token_abc123",
  "paymentType": "card",
  "totalAmount": "500.00",
  "paymentDate": "2026-01-30",
  "numberOfInstallments": 5,
  "amountPerInstallment": "100.00",
  "downPayment": "100.00",
  "regularity": "weekly",
  "planType": "settlement_plan",
  "payments": [
    { "paymentDate": "2026-01-30", "amount": "100.00", "processed": true },
    { "paymentDate": "2026-02-07", "amount": "100.00", "processed": false },
    { "paymentDate": "2026-02-14", "amount": "100.00", "processed": false },
    { "paymentDate": "2026-02-21", "amount": "100.00", "processed": false },
    { "paymentDate": "2026-02-28", "amount": "100.00", "processed": false }
  ],
  "phoneNumber": "+15125550123",
  "agentName": "Collections Agent"
}