Featured Pages  |  Ways to Use  |  Testimonials  |  FAQ  |  Search

Creating Collect Pages

Use this method to create a new collect page.

Method Info
Url https://www.payitsquare.com/api/v1/collect-page
Verb POST
Headers X-PayItSquare-AppKey, X-PayItSquare-Token
Input
Property Data Type Validation Info
Title String The title for the collect page. 150 characters max.
Details String This field could contain HTML tags
AllowSelfRegistration Boolean If true, users will be able to sign up directly on the collect page. Required
PassFeesToMembers Boolean If set to true, payers will have any credit card fees added to their amount due. When false, the organizer will receive the amount due minus any credit card fees. Required
OrganizerPaysAllFees Boolean If set to true, all fees will be subtracted from the amount the organizer gets. If false, payers will pay the fees.
AutoNotificationStatus Int32 Will be 0, 1, or 2. 0 indicates that auto reminders will become active after the first manual alert email is sent. 1 indicates that auto reminders are active. 2 indicates that auto reminders are disabled. Required
SendSelfPayAlerts Boolean If true, organizers will receive emails when a payer marks themselves as paid. Required
Mode String This will contain GroupPayment, Registration, or Fundraiser. GroupPayment is used for collecting money from a group of people. Registration is used for things like event registrations. Fundraiser is a way to raise money. Required
GoalAmt Single For fundraisers, this is the amount of money wanted. When set, payers will be able to track progress towards that goal from the collect page. Required
TrackGoalAmt Boolean When set to true, the collect page will track to a goal, and display progress on the public collect page. Required
ShowSocialLinks Boolean When set to true, social links will appear on the public view of the collect page.
ShowUnpaidTotals Boolean When set to true, payers will see a list of the projected totals for payers who have yet to pay.
ShowPaidTotals Boolean When set to true, payers will see a list of the totals for each payer who has paid.
ShowUnpaid Boolean When set to true, payers will see a list of the payers who have yet to pay. Required
ShowUnpaidCount Boolean When set to true, payers will be able to see the number of payers that have yet to pay. Required
ShowPaid Boolean When set to true, payers will see a list of who has paid. Required
ShowPaidCount Boolean When set to true, payers will see the number of payers who have paid. Required
IsPrivate Boolean When set to true, payers will be required to know the collect page's AccessCode to access it. Required
AccessCode String When IsPrivate is true, this code will be used to access the collect page. Required
DisablePayLater Boolean When true, payers who register for the collect page will not be allowed to pay later. Required
CurrencyCode String The currency used for this collect page. Required
LocalRegistrationDeadline String This is the deadline for registering for the collect page.
HasRegistrationDeadline Boolean If true, the collect page will enforce a deadline for registering
AllowPayments Boolean When false, no payments will be allowed for the collect page.
AllowSelfMarkPaidOffline Boolean If true, payers will be able to mark themselves as paid.
AllowPaymentsForUnpaidAfterDeadline Boolean When true, payers will be allowed to make payments after the deadline. Payers will still not be able to register.
ShowOrganizationName Boolean When true, the collect page will display the organizer's organization name instead of first and last name.
TimeZoneId String This indicates the time zone for this collect page.
HeaderBgColor String
TextColor String
OrganizerBgColor String
OrganizerTextColor String
EmailAddress String If set, this will override the organizer's email address and send payments to this address.
HasThankYouUrl Boolean Indicates that a payer will be redirected to the ThankYouUrl after completing a payment.
ThankYouUrl String The URL that a payer will be redirected to afteer completing a payment.
AllowPayersToContactOrganizer Boolean When true, payers will be given an option to use a contact form on the collect page to send a message to the organizer.
LetPayersChooseToPayFees Boolean When true, payers will be given the option to cover the fees for the payment.
Output
Property Data Type Other Info
Id Int32 This is the collect page id. It will be used as part of the URL for subsequent updates. Only available if the creation was successful.
PublicUrl String The link that payers can use to access the collect page to make payments. Only available if the creation was successful.
IsSuccess Boolean Indicates if the call was successful or not.
Messages String Array Will contain a list of error messages if IsSuccess is false
Sample Input
{
  "Title": "My Collect Page Title",
  "Details": "My Collect Page Details",
  "AllowSelfRegistration": true,
  "PassFeesToMembers": false,
  "OrganizerPaysAllFees": false,
  "AutoNotificationStatus": 2,
  "SendSelfPayAlerts": true,
  "Mode": "GroupPayment",
  "GoalAmt": 0.0,
  "TrackGoalAmt": false,
  "ShowSocialLinks": true,
  "ShowUnpaidTotals": false,
  "ShowPaidTotals": false,
  "ShowUnpaid": true,
  "ShowUnpaidCount": false,
  "ShowPaid": false,
  "ShowPaidCount": false,
  "IsPrivate": false,
  "AccessCode": null,
  "DisablePayLater": true,
  "CurrencyCode": "USD",
  "LocalRegistrationDeadline": null,
  "HasRegistrationDeadline": false,
  "AllowPayments": false,
  "AllowSelfMarkPaidOffline": false,
  "AllowPaymentsForUnpaidAfterDeadline": false,
  "ShowOrganizationName": false,
  "TimeZoneId": null,
  "HeaderBgColor": null,
  "TextColor": null,
  "OrganizerBgColor": null,
  "OrganizerTextColor": null,
  "EmailAddress": null,
  "HasThankYouUrl": false,
  "ThankYouUrl": null,
  "AllowPayersToContactOrganizer": false,
  "LetPayersChooseToPayFees": false
}
Sample Success Response
{
  "Id": 1234,
  "PublicUrl": "http://www.payitsquare.com/collect-page/1234",
  "IsSuccess": true,
  "Messages": []
}
Sample Error Response
{
  "Id": 0,
  "PublicUrl": null,
  "IsSuccess": false,
  "Messages": [
    "Error Message 1",
    "Error Message 2"
  ]
}
Processing...
Live Chat Support