GrowthZone REST API API Reference
undefined
API Endpoint
https://app.memberzone.orgRequest Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0
Paths
GET /api/widget/{id}
id:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/business_new
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/confirmationmessages/{key}
key:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
[
{
"Id": "string",
"Title": "string",
"Body": "string",
"Yes": "string",
"No": "string",
"IsDeleted": "boolean"
}
]
GET /api/widget/dashboardmetrics
200 OK
OK
Response Example (200 OK)
{
"ShowReportFavoritesWidget": "boolean",
"ShowWidgetsOnDashboard": "boolean",
"Widgets": "string",
"WidgetData": "string"
}
GET /api/widget/events_upcoming
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/find_businesses
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/forum
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/gatewayinfo/{paymentgatewayid}/{paymentgateways}/{contactid}/{hashedcontactid}
paymentgatewayid:
string
in path
(no description)
paymentgateways:
string
in path
(no description)
contactid:
string
in path
(no description)
hashedcontactid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/loginstatus
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
Inserts EpaymentTransaction record so we know about it
Inserts EpaymentTransaction record so we know about it
Same model posted with a normal charge
Request Example
{
"TenantId": "integer",
"TenantName": "string",
"ShowWithoutPaymentGateway": "boolean",
"OpenInvoices": "string",
"InvoicePaymentSelection": "string",
"IncludeRelatedContactsInvoices": "boolean",
"ContactId": "string",
"PurchasedByContactId": "string",
"SystemContactTypeId": "string",
"PaymentContactId": "string",
"OrganizationId": "string",
"SaveOnContactId": "string",
"SaveOnOrganizationId": "string",
"PaymentId": "integer",
"AuthProfilePageToken": "string",
"AuthProfileUrl": "string",
"ShowGateways": "boolean",
"ReadOnlyGateways": "boolean",
"GatewayAccountId": "string",
"ContactName": "string",
"PaymentProfileId": "string",
"ManageDpmProfilesAction": "string",
"PaymentGatewayId": "string",
"ConfigInfoJson": "string",
"PaymentGatewayTypeId": "string",
"GatewayErrorMessage": "string",
"GatewayErrorCleared": "string",
"CreditCardInfo": "string",
"CheckNumber": "string",
"StorePaymentInfoForFuture": "boolean",
"PayByNewCard": "boolean",
"TokenId": "string",
"Capture": "string",
"SimResponse": "string",
"EPaymentTransactionId": "integer",
"DataDescriptor": "string",
"DataValue": "string",
"IsTestCard": "boolean",
"CardType": "string",
"CardLast4": "string",
"CardExpMonth": "string",
"CardExpYear": "string",
"CardCvc": "string",
"PaymentDate": "string",
"Amount": "number",
"UseDefaultNrdsIdOverride": "boolean",
"VoluntaryAmount": "number",
"Currency": "string",
"GatewayAmounts": "string",
"IsBankCharge": "boolean",
"IsSavingsAccount": "boolean",
"IsTestBank": "boolean",
"CurrencyType": "string",
"Country": "string",
"PayerName": "string",
"PreferredEmailAddress": "string",
"AccountLast4": "string",
"BankName": "string",
"AccountNumber": "string",
"RoutingNumber": "string",
"AccountHolderType": "string",
"PurchaseId": "integer",
"TxnContactId": "integer",
"PaymentUsesGateway": "boolean",
"InitialModelLoaded": "boolean",
"ScheduledBillingItems": "string",
"Company": "string",
"FirstName": "string",
"LastName": "string",
"Address": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"StateProvince": "string",
"PostalCode": "string",
"CountryCode": "string",
"Email": "string",
"Phone": "string",
"HttpReferer": "string",
"ClientSideMethod": "string",
"ResponseData": "string",
"FailureReason": "string",
"forceSave": "boolean",
"NarPaymentsBaseUrl": "string",
"NRDSMemberId": "string",
"ContactNRDSMemberId": "string",
"DefaultNRDSMemberId": "string",
"HasNRDSMemberId": "string",
"CardAccountType": "string",
"NarSplitsInfo": "string",
"CanAddPaymentProfile": "boolean",
"SaleableItemAmounts": "string",
"AssociationRequestId": "string",
"AllowPartialPayments": "boolean",
"CssClass": "string",
"ShowEmailPaymentReceipt": "boolean",
"IsStaffOrAdmin": "boolean",
"EmailPaymentReceipt": "boolean",
"PaymentTerms": "string",
"PaymentSourceInfo": "string",
"SourceInfo": "string",
"HasRequiredLateFee": "boolean",
"RecaptchaToken": "string"
}
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
Updates NAR response for EpaymentTransaction record so we know about it
Updates NAR response for EpaymentTransaction record so we know about it
Model with raw response and any failures
Request Example
{
"EPaymentTransactionId": "integer",
"ResponseRawData": "string",
"FailureReason": "string",
"TransactionUID": "string"
}
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/narpayments/getcontactnrdsmemberid/{contactid}
contactid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
Returns a unique sequential RequestID which is needed for each request sent to NAR Payments
Returns a unique sequential RequestID which is needed for each request sent to NAR Payments
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
Returns the splits NAR Payments needs for the selected invoices This method should be called right before charge request is sent. Will record an "uncaptured" EpaymentTransaction so if we don't get a response from NAR we know about it in our system
Returns the splits NAR Payments needs for the selected invoices This method should be called right before charge request is sent. Will record an "uncaptured" EpaymentTransaction so if we don't get a response from NAR we know about it in our system
same model used for payment
Request Example
{
"TenantId": "integer",
"TenantName": "string",
"ShowWithoutPaymentGateway": "boolean",
"OpenInvoices": "string",
"InvoicePaymentSelection": "string",
"IncludeRelatedContactsInvoices": "boolean",
"ContactId": "string",
"PurchasedByContactId": "string",
"SystemContactTypeId": "string",
"PaymentContactId": "string",
"OrganizationId": "string",
"SaveOnContactId": "string",
"SaveOnOrganizationId": "string",
"PaymentId": "integer",
"AuthProfilePageToken": "string",
"AuthProfileUrl": "string",
"ShowGateways": "boolean",
"ReadOnlyGateways": "boolean",
"GatewayAccountId": "string",
"ContactName": "string",
"PaymentProfileId": "string",
"ManageDpmProfilesAction": "string",
"PaymentGatewayId": "string",
"ConfigInfoJson": "string",
"PaymentGatewayTypeId": "string",
"GatewayErrorMessage": "string",
"GatewayErrorCleared": "string",
"CreditCardInfo": "string",
"CheckNumber": "string",
"StorePaymentInfoForFuture": "boolean",
"PayByNewCard": "boolean",
"TokenId": "string",
"Capture": "string",
"SimResponse": "string",
"EPaymentTransactionId": "integer",
"DataDescriptor": "string",
"DataValue": "string",
"IsTestCard": "boolean",
"CardType": "string",
"CardLast4": "string",
"CardExpMonth": "string",
"CardExpYear": "string",
"CardCvc": "string",
"PaymentDate": "string",
"Amount": "number",
"UseDefaultNrdsIdOverride": "boolean",
"VoluntaryAmount": "number",
"Currency": "string",
"GatewayAmounts": "string",
"IsBankCharge": "boolean",
"IsSavingsAccount": "boolean",
"IsTestBank": "boolean",
"CurrencyType": "string",
"Country": "string",
"PayerName": "string",
"PreferredEmailAddress": "string",
"AccountLast4": "string",
"BankName": "string",
"AccountNumber": "string",
"RoutingNumber": "string",
"AccountHolderType": "string",
"PurchaseId": "integer",
"TxnContactId": "integer",
"PaymentUsesGateway": "boolean",
"InitialModelLoaded": "boolean",
"ScheduledBillingItems": "string",
"Company": "string",
"FirstName": "string",
"LastName": "string",
"Address": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"StateProvince": "string",
"PostalCode": "string",
"CountryCode": "string",
"Email": "string",
"Phone": "string",
"HttpReferer": "string",
"ClientSideMethod": "string",
"ResponseData": "string",
"FailureReason": "string",
"forceSave": "boolean",
"NarPaymentsBaseUrl": "string",
"NRDSMemberId": "string",
"ContactNRDSMemberId": "string",
"DefaultNRDSMemberId": "string",
"HasNRDSMemberId": "string",
"CardAccountType": "string",
"NarSplitsInfo": "string",
"CanAddPaymentProfile": "boolean",
"SaleableItemAmounts": "string",
"AssociationRequestId": "string",
"AllowPartialPayments": "boolean",
"CssClass": "string",
"ShowEmailPaymentReceipt": "boolean",
"IsStaffOrAdmin": "boolean",
"EmailPaymentReceipt": "boolean",
"PaymentTerms": "string",
"PaymentSourceInfo": "string",
"SourceInfo": "string",
"HasRequiredLateFee": "boolean",
"RecaptchaToken": "string"
}
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/partners
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
POST /api/widget/paymentprofiles/{hashedcontactid}
undefined
hashedcontactid:
string
in path
(no description)
Request Example
{
"ContactId": "integer",
"PaymentGatewayType": "string",
"PaymentGatewayId": "integer",
"PaymentGateways": "string",
"AllowBanks": "boolean"
}
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/preauth
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
POST /api/widget/preferences/update
undefined
Request Example
{
"ShowReportFavoritesWidget": "boolean",
"ShowWidgetsOnDashboard": "boolean",
"Widgets": "string",
"WidgetData": "string"
}
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/scheduledbillings/{contactid}/{organizationid}/{hashedcontactid}
contactid:
integer
in path
(no description)
organizationid:
string
in path
(no description)
hashedcontactid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/sponsorships
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/subscriptions
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/test
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/widget/web_content
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
Schema Definitions
ConfirmationMessageResult: object
- Id: string
- Title: string
- Body: string
- Yes: string
- No: string
- IsDeleted: boolean
Example
{
"Id": "string",
"Title": "string",
"Body": "string",
"Yes": "string",
"No": "string",
"IsDeleted": "boolean"
}
HttpResponseMessage: object
- Version: string
- Content: string
- StatusCode: string
- ReasonPhrase: string
- Headers: string
- RequestMessage: string
- IsSuccessStatusCode: boolean
Example
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
DashboardWidgetsViewModel: object
- ShowReportFavoritesWidget: boolean
- ShowWidgetsOnDashboard: boolean
- Widgets: string
- WidgetData: string
Example
{
"ShowReportFavoritesWidget": "boolean",
"ShowWidgetsOnDashboard": "boolean",
"Widgets": "string",
"WidgetData": "string"
}
PaymentProfilesFilter: object
- ContactId: integer
- PaymentGatewayType: string
- PaymentGatewayId: integer
- PaymentGateways: string
- AllowBanks: boolean
Example
{
"ContactId": "integer",
"PaymentGatewayType": "string",
"PaymentGatewayId": "integer",
"PaymentGateways": "string",
"AllowBanks": "boolean"
}
ExternalSourcePaymentModel: object
- TenantId: integer
- TenantName: string
- ShowWithoutPaymentGateway: boolean
- OpenInvoices: string
- InvoicePaymentSelection: string
- IncludeRelatedContactsInvoices: boolean
- ContactId: string
- PurchasedByContactId: string
- SystemContactTypeId: string
- PaymentContactId: string
- OrganizationId: string
- SaveOnContactId: string
- SaveOnOrganizationId: string
- PaymentId: integer
-
Not sure we will use this - probably delete later
- AuthProfilePageToken: string
- AuthProfileUrl: string
- ShowGateways: boolean
- ReadOnlyGateways: boolean
- GatewayAccountId: string
- ContactName: string
- PaymentProfileId: string
- ManageDpmProfilesAction: string
- PaymentGatewayId: string
- ConfigInfoJson: string
- PaymentGatewayTypeId: string
- GatewayErrorMessage: string
- GatewayErrorCleared: string
- CreditCardInfo: string
- CheckNumber: string
- StorePaymentInfoForFuture: boolean
- PayByNewCard: boolean
- TokenId: string
- Capture: string
- SimResponse: string
- EPaymentTransactionId: integer
- DataDescriptor: string
- DataValue: string
- IsTestCard: boolean
- CardType: string
- CardLast4: string
- CardExpMonth: string
- CardExpYear: string
- CardCvc: string
- PaymentDate: string
- Amount: number
- UseDefaultNrdsIdOverride: boolean
- VoluntaryAmount: number
- Currency: string
- GatewayAmounts: string
- IsBankCharge: boolean
- IsSavingsAccount: boolean
- IsTestBank: boolean
- CurrencyType: string
- Country: string
- PayerName: string
- PreferredEmailAddress: string
- AccountLast4: string
- BankName: string
- AccountNumber: string
- RoutingNumber: string
- AccountHolderType: string
- PurchaseId: integer
-
Optional parameter in case we are filtering to pay for a single invoice
- TxnContactId: integer
-
Optional parameter in case we are filtering to pay for a single invoice
- PaymentUsesGateway: boolean
- InitialModelLoaded: boolean
- ScheduledBillingItems: string
- Company: string
- FirstName: string
- LastName: string
- Address: string
- Address1: string
- Address2: string
- City: string
- StateProvince: string
- PostalCode: string
- CountryCode: string
- Email: string
- Phone: string
- HttpReferer: string
- ClientSideMethod: string
- ResponseData: string
- FailureReason: string
- forceSave: boolean
- NarPaymentsBaseUrl: string
- NRDSMemberId: string
- ContactNRDSMemberId: string
- DefaultNRDSMemberId: string
- HasNRDSMemberId: string
- CardAccountType: string
- NarSplitsInfo: string
- CanAddPaymentProfile: boolean
- SaleableItemAmounts: string
- AssociationRequestId: string
- AllowPartialPayments: boolean
- CssClass: string
- ShowEmailPaymentReceipt: boolean
- IsStaffOrAdmin: boolean
- EmailPaymentReceipt: boolean
- PaymentTerms: string
- PaymentSourceInfo: string
- SourceInfo: string
- HasRequiredLateFee: boolean
- RecaptchaToken: string
Example
{
"TenantId": "integer",
"TenantName": "string",
"ShowWithoutPaymentGateway": "boolean",
"OpenInvoices": "string",
"InvoicePaymentSelection": "string",
"IncludeRelatedContactsInvoices": "boolean",
"ContactId": "string",
"PurchasedByContactId": "string",
"SystemContactTypeId": "string",
"PaymentContactId": "string",
"OrganizationId": "string",
"SaveOnContactId": "string",
"SaveOnOrganizationId": "string",
"PaymentId": "integer",
"AuthProfilePageToken": "string",
"AuthProfileUrl": "string",
"ShowGateways": "boolean",
"ReadOnlyGateways": "boolean",
"GatewayAccountId": "string",
"ContactName": "string",
"PaymentProfileId": "string",
"ManageDpmProfilesAction": "string",
"PaymentGatewayId": "string",
"ConfigInfoJson": "string",
"PaymentGatewayTypeId": "string",
"GatewayErrorMessage": "string",
"GatewayErrorCleared": "string",
"CreditCardInfo": "string",
"CheckNumber": "string",
"StorePaymentInfoForFuture": "boolean",
"PayByNewCard": "boolean",
"TokenId": "string",
"Capture": "string",
"SimResponse": "string",
"EPaymentTransactionId": "integer",
"DataDescriptor": "string",
"DataValue": "string",
"IsTestCard": "boolean",
"CardType": "string",
"CardLast4": "string",
"CardExpMonth": "string",
"CardExpYear": "string",
"CardCvc": "string",
"PaymentDate": "string",
"Amount": "number",
"UseDefaultNrdsIdOverride": "boolean",
"VoluntaryAmount": "number",
"Currency": "string",
"GatewayAmounts": "string",
"IsBankCharge": "boolean",
"IsSavingsAccount": "boolean",
"IsTestBank": "boolean",
"CurrencyType": "string",
"Country": "string",
"PayerName": "string",
"PreferredEmailAddress": "string",
"AccountLast4": "string",
"BankName": "string",
"AccountNumber": "string",
"RoutingNumber": "string",
"AccountHolderType": "string",
"PurchaseId": "integer",
"TxnContactId": "integer",
"PaymentUsesGateway": "boolean",
"InitialModelLoaded": "boolean",
"ScheduledBillingItems": "string",
"Company": "string",
"FirstName": "string",
"LastName": "string",
"Address": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"StateProvince": "string",
"PostalCode": "string",
"CountryCode": "string",
"Email": "string",
"Phone": "string",
"HttpReferer": "string",
"ClientSideMethod": "string",
"ResponseData": "string",
"FailureReason": "string",
"forceSave": "boolean",
"NarPaymentsBaseUrl": "string",
"NRDSMemberId": "string",
"ContactNRDSMemberId": "string",
"DefaultNRDSMemberId": "string",
"HasNRDSMemberId": "string",
"CardAccountType": "string",
"NarSplitsInfo": "string",
"CanAddPaymentProfile": "boolean",
"SaleableItemAmounts": "string",
"AssociationRequestId": "string",
"AllowPartialPayments": "boolean",
"CssClass": "string",
"ShowEmailPaymentReceipt": "boolean",
"IsStaffOrAdmin": "boolean",
"EmailPaymentReceipt": "boolean",
"PaymentTerms": "string",
"PaymentSourceInfo": "string",
"SourceInfo": "string",
"HasRequiredLateFee": "boolean",
"RecaptchaToken": "string"
}