GrowthZone REST API API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

Stripe

DELETE /api/integration/stripe/account/{accountid}/bankaccount/{bankid}

accountid: string
in path

(no description)

bankid: string
in path

(no description)

200 OK
JsonResult<String>

OK

Response Example (200 OK) 
{
  "Content": "string",
  "SerializerSettings": "string",
  "Encoding": "string",
  "Request": "string"
}
Stripe

POST /api/integration/stripe/account/{accountid}/bankaccount/{bankid}/{defaultforcurrency}

accountid: object
in path

(no description)

bankid: object
in path

(no description)

defaultforcurrency: boolean
in path

(no description)

200 OK
JsonResult<String>

OK

Response Example (200 OK) 
{
  "Content": "string",
  "SerializerSettings": "string",
  "Encoding": "string",
  "Request": "string"
}
Stripe

POST /api/integration/stripe/account/{accountid}/identityfile

accountid: object
in path

(no description)

200 OK
String

OK

type
String
Response Example (200 OK) 
[
  {
    "this[]": "string",
    "Length": "integer"
  }
]
Stripe

GET /api/integration/stripe/charge

200 OK
HttpResponseMessage

OK

Response Example (200 OK) 
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}
Stripe

GET /api/integration/stripe/connectaccountcharges

200 OK
ConnectAccountChargesModel

OK

Response Example (200 OK) 
{
  "Instructions": "string",
  "StartDate": "string",
  "EndDate": "string",
  "FileFormat": "string",
  "ListViewItems": "string",
  "FileId": "string",
  "DownloadUrl": "string"
}
Stripe

POST /api/integration/stripe/connectaccountcharges

ConnectAccountChargesModel

undefined

Request Example
{
  "Instructions": "string",
  "StartDate": "string",
  "EndDate": "string",
  "FileFormat": "string",
  "ListViewItems": "string",
  "FileId": "string",
  "DownloadUrl": "string"
}
200 OK
PendingFileDownloadResult

OK

Response Example (200 OK) 
{
  "JobType": "string",
  "Message": "string",
  "Result": "string",
  "BackgroundJobEstimatedSeconds": "integer",
  "JobId": "string",
  "PendingDownloadFileId": "integer"
}
Stripe

GET /api/integration/stripe/countries

200 OK
HttpResponseMessage

OK

Response Example (200 OK) 
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}
Stripe

POST /api/integration/stripe/dispute/evidence/file

200 OK
String

OK

type
String
Response Example (200 OK) 
[
  {
    "this[]": "string",
    "Length": "integer"
  }
]
Stripe

GET /api/integration/stripe/disputes

200 OK
DisputedEpaymentCollectionItemModel

OK

type
DisputedEpaymentCollectionItemModel
Response Example (200 OK) 
[
  {
    "EPaymentTransactionId": "integer",
    "TransactionUID": "string",
    "Amount": "number",
    "ContactName": "string",
    "GatewayName": "string",
    "ChargeDate": "string",
    "DisputeDate": "string",
    "Status": "string"
  }
]
Stripe

POST /api/integration/stripe/disputes/{epaymenttransactionid}

DisputedEpaymentEditModel

undefined

epaymenttransactionid: string
in path

(no description)

Request Example
{
  "EPaymentTransactionId": "integer",
  "PaymentId": "integer",
  "PaymentGatewayTypeId": "string",
  "DisputeId": "string",
  "TransactionUID": "string",
  "ContactName": "string",
  "GatewayName": "string",
  "ChargeDate": "string",
  "DisputeDate": "string",
  "Amount": "string",
  "Status": "string",
  "DueBy": "string",
  "Reason": "string",
  "DisputeRawData": "string",
  "DisputeInfo": "string",
  "Messages": "string",
  "Documents": "string",
  "product_description": "string",
  "customer_name": "string",
  "customer_email_address": "string",
  "billing_address": "string",
  "customer_purchase_ip": "string",
  "receipt": "string",
  "customer_signature": "string",
  "customer_communication": "string",
  "shipping_carrier": "string",
  "shipping_tracking_number": "string",
  "shipping_documentation": "string",
  "shipping_date": "string",
  "shipping_address": "string",
  "access_activity_log": "string",
  "service_date": "string",
  "service_documentation": "string",
  "duplicate_charge_id": "string",
  "duplicate_charge_explanation": "string",
  "duplicate_charge_documentation": "string",
  "refund_policy_disclosure": "string",
  "refund_refusal_explanation": "string",
  "refund_policy": "string",
  "cancellation_policy_disclosure": "string",
  "cancellation_rebuttal": "string",
  "cancellation_policy": "string",
  "uncategorized_text": "string",
  "uncategorized_file": "string"
}
200 OK
DisputedEpaymentCollectionItemModel

OK

Response Example (200 OK) 
{
  "EPaymentTransactionId": "integer",
  "TransactionUID": "string",
  "Amount": "number",
  "ContactName": "string",
  "GatewayName": "string",
  "ChargeDate": "string",
  "DisputeDate": "string",
  "Status": "string"
}
Stripe

GET /api/integration/stripe/disputes/{epaymenttransactionid}/{transactionuid}

epaymenttransactionid: integer
in path

(no description)

transactionuid: string
in path

(no description)

200 OK
DisputedEpaymentEditModel

OK

Response Example (200 OK) 
{
  "EPaymentTransactionId": "integer",
  "PaymentId": "integer",
  "PaymentGatewayTypeId": "string",
  "DisputeId": "string",
  "TransactionUID": "string",
  "ContactName": "string",
  "GatewayName": "string",
  "ChargeDate": "string",
  "DisputeDate": "string",
  "Amount": "string",
  "Status": "string",
  "DueBy": "string",
  "Reason": "string",
  "DisputeRawData": "string",
  "DisputeInfo": "string",
  "Messages": "string",
  "Documents": "string",
  "product_description": "string",
  "customer_name": "string",
  "customer_email_address": "string",
  "billing_address": "string",
  "customer_purchase_ip": "string",
  "receipt": "string",
  "customer_signature": "string",
  "customer_communication": "string",
  "shipping_carrier": "string",
  "shipping_tracking_number": "string",
  "shipping_documentation": "string",
  "shipping_date": "string",
  "shipping_address": "string",
  "access_activity_log": "string",
  "service_date": "string",
  "service_documentation": "string",
  "duplicate_charge_id": "string",
  "duplicate_charge_explanation": "string",
  "duplicate_charge_documentation": "string",
  "refund_policy_disclosure": "string",
  "refund_refusal_explanation": "string",
  "refund_policy": "string",
  "cancellation_policy_disclosure": "string",
  "cancellation_rebuttal": "string",
  "cancellation_policy": "string",
  "uncategorized_text": "string",
  "uncategorized_file": "string"
}
Stripe

GET /api/integration/stripe/negativebalances

200 OK
NegativeBalancesModel

OK

Response Example (200 OK) 
{
  "Instructions": "string",
  "FileFormat": "string",
  "ListViewItems": "string",
  "FileId": "string",
  "DownloadUrl": "string",
  "SecretKey": "string"
}
Stripe

POST /api/integration/stripe/negativebalances

NegativeBalancesModel

undefined

Request Example
{
  "Instructions": "string",
  "FileFormat": "string",
  "ListViewItems": "string",
  "FileId": "string",
  "DownloadUrl": "string",
  "SecretKey": "string"
}
200 OK
PendingFileDownloadResult

OK

Response Example (200 OK) 
{
  "JobType": "string",
  "Message": "string",
  "Result": "string",
  "BackgroundJobEstimatedSeconds": "integer",
  "JobId": "string",
  "PendingDownloadFileId": "integer"
}
Stripe

GET /api/integration/stripe/striperequirementsdetails

200 OK
StripeRequirementsDetailModel

OK

Response Example (200 OK) 
{
  "FutureRequirementsMessage": "string",
  "RequirementsMessage": "string",
  "UpdateInstructions": "string",
  "CurrentDeadline": "string",
  "FutureAccountListHtml": "string",
  "AccountListHtml": "string",
  "FutureAccountList": "string",
  "AccountList": "string",
  "HasAccess": "boolean"
}
Stripe

POST /api/integration/stripe/striperequirementsdetails

200 OK
ApplicationRootPage

OK

Response Example (200 OK) 
{
  "CurrentUserId": "integer",
  "CurrentUserOrgId": "integer",
  "CurrentLoginId": "integer",
  "ProductType": "string",
  "QuickActions": "string",
  "QuickActionsV2": "string",
  "FamilyQuickAction": "string",
  "UserActions": "string",
  "UserActionsV2": "string",
  "CreateSiteActions": "string",
  "HideSwitchAccountMenuItem": "boolean",
  "ActionRequired": "boolean",
  "V2UIEnabled": "boolean",
  "OtherActions": "string"
}
Stripe

GET /api/integration/stripe/test

accountid: string
in query

(no description)

200 OK
HttpResponseMessage

OK

Response Example (200 OK) 
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

Schema Definitions

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"
}

JsonResult<String>: object

Content: string
SerializerSettings: string
Encoding: string
Request: string
Example
{
  "Content": "string",
  "SerializerSettings": "string",
  "Encoding": "string",
  "Request": "string"
}

String: object

this[]: string
Length: integer
Example
{
  "this[]": "string",
  "Length": "integer"
}

NegativeBalancesModel: object

Instructions: string
FileFormat: string
ListViewItems: string
FileId: string
DownloadUrl: string
SecretKey: string
Example
{
  "Instructions": "string",
  "FileFormat": "string",
  "ListViewItems": "string",
  "FileId": "string",
  "DownloadUrl": "string",
  "SecretKey": "string"
}

PendingFileDownloadResult: object

JobType: string
Message: string
Result: string
BackgroundJobEstimatedSeconds: integer
JobId: string
PendingDownloadFileId: integer
Example
{
  "JobType": "string",
  "Message": "string",
  "Result": "string",
  "BackgroundJobEstimatedSeconds": "integer",
  "JobId": "string",
  "PendingDownloadFileId": "integer"
}

DisputedEpaymentCollectionItemModel: object

EPaymentTransactionId: integer
TransactionUID: string
Amount: number
ContactName: string
GatewayName: string
ChargeDate: string
DisputeDate: string
Status: string
Example
{
  "EPaymentTransactionId": "integer",
  "TransactionUID": "string",
  "Amount": "number",
  "ContactName": "string",
  "GatewayName": "string",
  "ChargeDate": "string",
  "DisputeDate": "string",
  "Status": "string"
}

DisputedEpaymentEditModel: object

EPaymentTransactionId: integer
PaymentId: integer
PaymentGatewayTypeId: string
DisputeId: string
TransactionUID: string
ContactName: string
GatewayName: string
ChargeDate: string
DisputeDate: string
Amount: string
Status: string
DueBy: string
Reason: string
DisputeRawData: string
DisputeInfo: string
Messages: string
Documents: string
product_description: string
customer_name: string
customer_email_address: string
billing_address: string
customer_purchase_ip: string
receipt: string
customer_signature: string
customer_communication: string
shipping_carrier: string
shipping_tracking_number: string
shipping_documentation: string
shipping_date: string
shipping_address: string
access_activity_log: string
service_date: string
service_documentation: string
duplicate_charge_id: string
duplicate_charge_explanation: string
duplicate_charge_documentation: string
refund_policy_disclosure: string
refund_refusal_explanation: string
refund_policy: string
cancellation_policy_disclosure: string
cancellation_rebuttal: string
cancellation_policy: string
uncategorized_text: string
uncategorized_file: string
Example
{
  "EPaymentTransactionId": "integer",
  "PaymentId": "integer",
  "PaymentGatewayTypeId": "string",
  "DisputeId": "string",
  "TransactionUID": "string",
  "ContactName": "string",
  "GatewayName": "string",
  "ChargeDate": "string",
  "DisputeDate": "string",
  "Amount": "string",
  "Status": "string",
  "DueBy": "string",
  "Reason": "string",
  "DisputeRawData": "string",
  "DisputeInfo": "string",
  "Messages": "string",
  "Documents": "string",
  "product_description": "string",
  "customer_name": "string",
  "customer_email_address": "string",
  "billing_address": "string",
  "customer_purchase_ip": "string",
  "receipt": "string",
  "customer_signature": "string",
  "customer_communication": "string",
  "shipping_carrier": "string",
  "shipping_tracking_number": "string",
  "shipping_documentation": "string",
  "shipping_date": "string",
  "shipping_address": "string",
  "access_activity_log": "string",
  "service_date": "string",
  "service_documentation": "string",
  "duplicate_charge_id": "string",
  "duplicate_charge_explanation": "string",
  "duplicate_charge_documentation": "string",
  "refund_policy_disclosure": "string",
  "refund_refusal_explanation": "string",
  "refund_policy": "string",
  "cancellation_policy_disclosure": "string",
  "cancellation_rebuttal": "string",
  "cancellation_policy": "string",
  "uncategorized_text": "string",
  "uncategorized_file": "string"
}

ConnectAccountChargesModel: object

Instructions: string
StartDate: string
EndDate: string
FileFormat: string
ListViewItems: string
FileId: string
DownloadUrl: string
Example
{
  "Instructions": "string",
  "StartDate": "string",
  "EndDate": "string",
  "FileFormat": "string",
  "ListViewItems": "string",
  "FileId": "string",
  "DownloadUrl": "string"
}

StripeRequirementsDetailModel: object

FutureRequirementsMessage: string
RequirementsMessage: string
UpdateInstructions: string
CurrentDeadline: string
FutureAccountListHtml: string
AccountListHtml: string
FutureAccountList: string
AccountList: string
HasAccess: boolean
Example
{
  "FutureRequirementsMessage": "string",
  "RequirementsMessage": "string",
  "UpdateInstructions": "string",
  "CurrentDeadline": "string",
  "FutureAccountListHtml": "string",
  "AccountListHtml": "string",
  "FutureAccountList": "string",
  "AccountList": "string",
  "HasAccess": "boolean"
}

ApplicationRootPage: object

CurrentUserId: integer

Current user contact id.

CurrentUserOrgId: integer

Current user org id.

CurrentLoginId: integer

Current user login id.

ProductType: string
QuickActions: string
QuickActionsV2: string
FamilyQuickAction: string
UserActions: string
UserActionsV2: string
CreateSiteActions: string
HideSwitchAccountMenuItem: boolean
ActionRequired: boolean
V2UIEnabled: boolean
OtherActions: string
Example
{
  "CurrentUserId": "integer",
  "CurrentUserOrgId": "integer",
  "CurrentLoginId": "integer",
  "ProductType": "string",
  "QuickActions": "string",
  "QuickActionsV2": "string",
  "FamilyQuickAction": "string",
  "UserActions": "string",
  "UserActionsV2": "string",
  "CreateSiteActions": "string",
  "HideSwitchAccountMenuItem": "boolean",
  "ActionRequired": "boolean",
  "V2UIEnabled": "boolean",
  "OtherActions": "string"
}
Documentation by Spectacle