The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
API reference
/
Models
CampaignProgressDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
A campaign's public progress, as served by the anonymous progress endpoint.
Values
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.
Fields
Field
Type
Description campaignId
required string (uuid)
The 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.
completedCount
required integer (int32)
Approved payments counted 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.
total
required number (double)
The net collected total, in the merchant's currency.
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` when it has 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.
maxCompletions
required integer (int32)
The number of payments the campaign will take before it ends, or `null` when it has no such 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.
percentOfGoal
required integer (int32)
The 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.
This model has no documented fields.
Next steps