GET v2/Subscriber/{subscriberId}/Location/{locationId}/PayoutAccount/Stripe/OnboardingBankRequirements

Obtains the required fields and associated bank validations needed to onboard a subscriber at a country for a Stripe Payout account.

Request Information

URI Parameters

Name	Description	Type	Additional information
subscriberId		integer	Required
locationId		integer	Required

Body Parameters

None.

Response Information

Resource Description

GetStripePayoutAccountOnboardingBankRequirementsResponse

Name	Description	Type	Additional information
bankRequirements		Collection of Collection of StripeOnboardingField	None.
supportedBanks		Dictionary of string [key] and Collection of string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "bankRequirements": [
    [
      {
        "requiredFor": "BusinessOnly",
        "fieldType": "BusinessType",
        "fieldDataType": "Date",
        "fieldValue": "sample string 1",
        "fieldName": "sample string 2",
        "fieldExample": "sample string 3",
        "tipsyText": "sample string 4",
        "htmlTag": "InputText",
        "htmlSelectOptions": [
          {
            "value": "sample string 1",
            "text": "sample string 2"
          },
          {
            "value": "sample string 1",
            "text": "sample string 2"
          }
        ],
        "editable": true,
        "minimumLength": 1,
        "maximumLength": 1
      },
      {
        "requiredFor": "BusinessOnly",
        "fieldType": "BusinessType",
        "fieldDataType": "Date",
        "fieldValue": "sample string 1",
        "fieldName": "sample string 2",
        "fieldExample": "sample string 3",
        "tipsyText": "sample string 4",
        "htmlTag": "InputText",
        "htmlSelectOptions": [
          {
            "value": "sample string 1",
            "text": "sample string 2"
          },
          {
            "value": "sample string 1",
            "text": "sample string 2"
          }
        ],
        "editable": true,
        "minimumLength": 1,
        "maximumLength": 1
      }
    ],
    [
      {
        "requiredFor": "BusinessOnly",
        "fieldType": "BusinessType",
        "fieldDataType": "Date",
        "fieldValue": "sample string 1",
        "fieldName": "sample string 2",
        "fieldExample": "sample string 3",
        "tipsyText": "sample string 4",
        "htmlTag": "InputText",
        "htmlSelectOptions": [
          {
            "value": "sample string 1",
            "text": "sample string 2"
          },
          {
            "value": "sample string 1",
            "text": "sample string 2"
          }
        ],
        "editable": true,
        "minimumLength": 1,
        "maximumLength": 1
      },
      {
        "requiredFor": "BusinessOnly",
        "fieldType": "BusinessType",
        "fieldDataType": "Date",
        "fieldValue": "sample string 1",
        "fieldName": "sample string 2",
        "fieldExample": "sample string 3",
        "tipsyText": "sample string 4",
        "htmlTag": "InputText",
        "htmlSelectOptions": [
          {
            "value": "sample string 1",
            "text": "sample string 2"
          },
          {
            "value": "sample string 1",
            "text": "sample string 2"
          }
        ],
        "editable": true,
        "minimumLength": 1,
        "maximumLength": 1
      }
    ]
  ],
  "supportedBanks": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetStripePayoutAccountOnboardingBankRequirementsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Subscriber.Payouts.V2.Responses">
  <BankRequirements xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Subscriber.Payouts.V2.Models.OnboardingRequirements">
    <d2p1:ArrayOfStripeOnboardingField>
      <d2p1:StripeOnboardingField>
        <d2p1:Editable>true</d2p1:Editable>
        <d2p1:FieldDataType>Date</d2p1:FieldDataType>
        <d2p1:FieldExample>sample string 3</d2p1:FieldExample>
        <d2p1:FieldName>sample string 2</d2p1:FieldName>
        <d2p1:FieldType>BusinessType</d2p1:FieldType>
        <d2p1:FieldValue>sample string 1</d2p1:FieldValue>
        <d2p1:HtmlSelectOptions>
          <d2p1:HtmlSelectOption>
            <d2p1:Text>sample string 2</d2p1:Text>
            <d2p1:Value>sample string 1</d2p1:Value>
          </d2p1:HtmlSelectOption>
          <d2p1:HtmlSelectOption>
            <d2p1:Text>sample string 2</d2p1:Text>
            <d2p1:Value>sample string 1</d2p1:Value>
          </d2p1:HtmlSelectOption>
        </d2p1:HtmlSelectOptions>
        <d2p1:HtmlTag>InputText</d2p1:HtmlTag>
        <d2p1:MaximumLength>1</d2p1:MaximumLength>
        <d2p1:MinimumLength>1</d2p1:MinimumLength>
        <d2p1:RequiredFor>BusinessOnly</d2p1:RequiredFor>
        <d2p1:TipsyText>sample string 4</d2p1:TipsyText>
      </d2p1:StripeOnboardingField>
      <d2p1:StripeOnboardingField>
        <d2p1:Editable>true</d2p1:Editable>
        <d2p1:FieldDataType>Date</d2p1:FieldDataType>
        <d2p1:FieldExample>sample string 3</d2p1:FieldExample>
        <d2p1:FieldName>sample string 2</d2p1:FieldName>
        <d2p1:FieldType>BusinessType</d2p1:FieldType>
        <d2p1:FieldValue>sample string 1</d2p1:FieldValue>
        <d2p1:HtmlSelectOptions>
          <d2p1:HtmlSelectOption>
            <d2p1:Text>sample string 2</d2p1:Text>
            <d2p1:Value>sample string 1</d2p1:Value>
          </d2p1:HtmlSelectOption>
          <d2p1:HtmlSelectOption>
            <d2p1:Text>sample string 2</d2p1:Text>
            <d2p1:Value>sample string 1</d2p1:Value>
          </d2p1:HtmlSelectOption>
        </d2p1:HtmlSelectOptions>
        <d2p1:HtmlTag>InputText</d2p1:HtmlTag>
        <d2p1:MaximumLength>1</d2p1:MaximumLength>
        <d2p1:MinimumLength>1</d2p1:MinimumLength>
        <d2p1:RequiredFor>BusinessOnly</d2p1:RequiredFor>
        <d2p1:TipsyText>sample string 4</d2p1:TipsyText>
      </d2p1:StripeOnboardingField>
    </d2p1:ArrayOfStripeOnboardingField>
    <d2p1:ArrayOfStripeOnboardingField>
      <d2p1:StripeOnboardingField>
        <d2p1:Editable>true</d2p1:Editable>
        <d2p1:FieldDataType>Date</d2p1:FieldDataType>
        <d2p1:FieldExample>sample string 3</d2p1:FieldExample>
        <d2p1:FieldName>sample string 2</d2p1:FieldName>
        <d2p1:FieldType>BusinessType</d2p1:FieldType>
        <d2p1:FieldValue>sample string 1</d2p1:FieldValue>
        <d2p1:HtmlSelectOptions>
          <d2p1:HtmlSelectOption>
            <d2p1:Text>sample string 2</d2p1:Text>
            <d2p1:Value>sample string 1</d2p1:Value>
          </d2p1:HtmlSelectOption>
          <d2p1:HtmlSelectOption>
            <d2p1:Text>sample string 2</d2p1:Text>
            <d2p1:Value>sample string 1</d2p1:Value>
          </d2p1:HtmlSelectOption>
        </d2p1:HtmlSelectOptions>
        <d2p1:HtmlTag>InputText</d2p1:HtmlTag>
        <d2p1:MaximumLength>1</d2p1:MaximumLength>
        <d2p1:MinimumLength>1</d2p1:MinimumLength>
        <d2p1:RequiredFor>BusinessOnly</d2p1:RequiredFor>
        <d2p1:TipsyText>sample string 4</d2p1:TipsyText>
      </d2p1:StripeOnboardingField>
      <d2p1:StripeOnboardingField>
        <d2p1:Editable>true</d2p1:Editable>
        <d2p1:FieldDataType>Date</d2p1:FieldDataType>
        <d2p1:FieldExample>sample string 3</d2p1:FieldExample>
        <d2p1:FieldName>sample string 2</d2p1:FieldName>
        <d2p1:FieldType>BusinessType</d2p1:FieldType>
        <d2p1:FieldValue>sample string 1</d2p1:FieldValue>
        <d2p1:HtmlSelectOptions>
          <d2p1:HtmlSelectOption>
            <d2p1:Text>sample string 2</d2p1:Text>
            <d2p1:Value>sample string 1</d2p1:Value>
          </d2p1:HtmlSelectOption>
          <d2p1:HtmlSelectOption>
            <d2p1:Text>sample string 2</d2p1:Text>
            <d2p1:Value>sample string 1</d2p1:Value>
          </d2p1:HtmlSelectOption>
        </d2p1:HtmlSelectOptions>
        <d2p1:HtmlTag>InputText</d2p1:HtmlTag>
        <d2p1:MaximumLength>1</d2p1:MaximumLength>
        <d2p1:MinimumLength>1</d2p1:MinimumLength>
        <d2p1:RequiredFor>BusinessOnly</d2p1:RequiredFor>
        <d2p1:TipsyText>sample string 4</d2p1:TipsyText>
      </d2p1:StripeOnboardingField>
    </d2p1:ArrayOfStripeOnboardingField>
  </BankRequirements>
  <SupportedBanks xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </SupportedBanks>
</GetStripePayoutAccountOnboardingBankRequirementsResponse>