extraProperties
required |
object
|
nullableread only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
creationTime
required |
string (date-time)
|
The date and time when this entity was created.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
creatorId
required |
string (uuid)
|
The ID of the user who created this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastModificationTime
required |
string (date-time)
|
The date and time when this entity was last modified.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastModifierId
required |
string (uuid)
|
The ID of the user who last modified this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isDeleted
required |
boolean
|
Indicates whether this entity has been deleted.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
deleterId
required |
string (uuid)
|
The ID of the user who deleted this entity, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
deletionTime
required |
string (date-time)
|
The date and time when this entity was deleted, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
merchantId
required |
string (uuid)
|
The merchant that owns this campaign.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
name
required |
string
|
Operator-facing campaign name.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
description
required |
string
|
Free-text description of the campaign.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
status
required |
CampaignStatus
CampaignStatus |
The campaign's status right now. A running campaign whose scheduled end has already passed
reads as `Ended` here, without anything having been written to it.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Draft |
Being prepared, and not yet running. | Active |
Running. The campaign admits member links, subject to its schedule and to their own status. | Paused |
Suspended by the merchant, and resumable back to Active. | Ended |
Finished. Terminal, though the campaign stays editable and reportable. | Archived |
Retired from the working set. No page or payment link may join it. |
|
endedReason
required |
CampaignEndedReason
CampaignEndedReason |
Why the campaign ended, or `null` while it has not ended. A campaign that ended only
because its window closed reports `Schedule`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Manual |
A merchant user ended it explicitly. | Schedule |
Its scheduled window closed. | CompletionCap |
Its configured completion count was reached. | AmountCap |
Its configured collected-amount ceiling was reached. |
|
endedAtUtc
required |
string (date-time)
|
UTC moment the campaign was ended or archived out of a running state, or `null` while it
has not been. A campaign that reads as ended only because its window closed carries none: its
`endsAtUtc` is its end.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isAcceptingPayments
required |
boolean
|
Whether member payment links may transact through this campaign right now. False before the
scheduled start, and for any status other than active.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
startsAtUtc
required |
string (date-time)
|
UTC moment the campaign starts accepting payments.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
endsAtUtc
required |
string (date-time)
|
UTC moment the campaign stops accepting payments.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
inactiveMessage
required |
string
|
Payer-facing message shown while the campaign is not accepting payments.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
externalReference
required |
string
|
The merchant's own identifier for this campaign.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
overrides
required |
CampaignOverridesDto
CampaignOverridesDto |
Branding and text laid over every hosted page and payment link in the campaign when it
renders. A member that is `null` inherits each member page's own value.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
clonedFromCampaignId
required |
string (uuid)
|
The campaign this one was cloned from, or `null` for a campaign created from scratch.
The source may have been deleted since; the reference is kept either way.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
maxCompletions
required |
integer (int32)
|
The number of approved payments at which the campaign ends on its own, or `null` for no completion cap.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
maxTotalAmount
required |
number (double)
|
The net collected amount at which the campaign ends on its own, or `null` for no amount cap.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
goalAmount
required |
number (double)
|
The amount the campaign is aiming to collect, or `null` for no goal.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
refundsReduceTotal
required |
boolean
|
Whether refunds, voids and reversals reduce the collected total.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
showProgress
required |
boolean
|
Whether the campaign's progress is shown to payers and published anonymously.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
completedCount
required |
integer (int32)
|
Approved payments counted so far. Zero on a campaign that has taken none.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
approvedTotal
required |
number (double)
|
The approved base amount collected so far, before any refund.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
refundedTotal
required |
number (double)
|
The amount refunded, voided or reversed so far.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
netTotal
required |
number (double)
|
The total the caps and the goal are measured against: approved less refunded when refunds
reduce the total, approved otherwise.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastCompletedAtUtc
required |
string (date-time)
|
When the most recent approved payment was counted (UTC), or `null` before the first.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
percentOfGoal
required |
integer (int32)
|
The net total as a whole percentage of the goal, not capped at 100, or `null` without a goal.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
concurrencyStamp
required |
string
|
Optimistic concurrency token.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|