Stripe Connect module API index
Dashboard
MaxMind GeoIP
Organizations
Stripe Connect
Stripe Subscriptions
OAuth
Example app
Example subscription app
Documentation
Configuration
UI
API
User API
/api/user/connect/country-spec
get
await global.api.user.connect.CountrySpec.get(req)
/api/user/connect/country-specs-count
get
await global.api.user.connect.CountrySpecsCount.get(req)
/api/user/connect/country-specs
get
await global.api.user.connect.CountrySpecs.get(req)
URL
all
limit
offset
/api/user/connect/create-person
post
await global.api.user.connect.CreatePerson.post(req)
POST
relationship_director
relationship_executive
relationship_owner
relationship_percent_ownership
relationship_representative
relationship_title
/api/user/connect/create-stripe-account
post
await global.api.user.connect.CreateStripeAccount.post(req)
/api/user/connect/delete-person
delete
await global.api.user.connect.DeletePerson.delete(req)
/api/user/connect/delete-stripe-account
delete
await global.api.user.connect.DeleteStripeAccount.delete(req)
/api/user/connect/payout
get
await global.api.user.connect.Payout.get(req)
/api/user/connect/payouts-count
get
await global.api.user.connect.PayoutsCount.get(req)
/api/user/connect/payouts
get
await global.api.user.connect.Payouts.get(req)
URL
all
limit
offset
stripeid
/api/user/connect/person
get
await global.api.user.connect.Person.get(req)
/api/user/connect/persons-count
get
await global.api.user.connect.PersonsCount.get(req)
/api/user/connect/persons
get
await global.api.user.connect.Persons.get(req)
URL
all
limit
offset
/api/user/connect/set-company-directors-submitted
patch
await global.api.user.connect.SetCompanyDirectorsSubmitted.patch(req)
/api/user/connect/set-company-executives-submitted
patch
await global.api.user.connect.SetCompanyExecutivesSubmitted.patch(req)
/api/user/connect/set-company-owners-submitted
patch
await global.api.user.connect.SetCompanyOwnersSubmitted.patch(req)
/api/user/connect/set-stripe-account-submitted
patch
await global.api.user.connect.SetStripeAccountSubmitted.patch(req)
/api/user/connect/stripe-account
get
await global.api.user.connect.StripeAccount.get(req)
/api/user/connect/stripe-accounts-count
get
await global.api.user.connect.StripeAccountsCount.get(req)
/api/user/connect/stripe-accounts
get
await global.api.user.connect.StripeAccounts.get(req)
URL
all
limit
offset
/api/user/connect/update-payment-information
patch
await global.api.user.connect.UpdatePaymentInformation.patch(req)
POST
account_holder_type
account_number
bank_code
branch_code
bsb_number
clearing_code
currency
iban
institution_number
routing_number
sort_code
transit_number
/api/user/connect/update-person
patch
await global.api.user.connect.UpdatePerson.patch(req)
POST
address_city
address_line1
address_postal_code
address_state
dob_day
dob_month
dob_year
email
phone
ssn_last_4
verification_additional_document_back
verification_additional_document_front
verification_document_back
verification_document_front
/api/user/connect/update-stripe-account
patch
await global.api.user.connect.UpdateStripeAccount.patch(req)
POST
company_address_city
company_address_kana_city
company_address_kana_line1
company_address_kana_postal_code
company_address_kana_state
company_address_kana_town
company_address_kanji_city
company_address_kanji_line1
company_address_kanji_postal_code
company_address_kanji_state
company_address_kanji_town
company_address_line1
company_address_postal_code
company_address_state
company_name
company_phone
company_registration_number
company_tax_id
individual_address_city
individual_address_kana_city
individual_address_kana_line1
individual_address_kana_postal_code
individual_address_kana_state
individual_address_kana_town
individual_address_kanji_city
individual_address_kanji_line1
individual_address_kanji_postal_code
individual_address_kanji_state
individual_address_kanji_town
individual_address_line1
individual_address_postal_code
individual_address_state
individual_dob_day
individual_dob_month
individual_dob_year
individual_email
individual_id_number
individual_phone
individual_ssn_last_4
Administrator API
/api/administrator/connect/delete-stripe-account
delete
await global.api.administrator.connect.DeleteStripeAccount.delete(req)
/api/administrator/connect/payout
get
await global.api.administrator.connect.Payout.get(req)
/api/administrator/connect/payouts-count
get
await global.api.administrator.connect.PayoutsCount.get(req)
/api/administrator/connect/payouts
get
await global.api.administrator.connect.Payouts.get(req)
URL
accountid
all
limit
offset
stripeid
/api/administrator/connect/person
get
await global.api.administrator.connect.Person.get(req)
/api/administrator/connect/persons-count
get
await global.api.administrator.connect.PersonsCount.get(req)
URL
stripeid
/api/administrator/connect/persons
get
await global.api.administrator.connect.Persons.get(req)
URL
all
limit
offset
stripeid
/api/administrator/connect/set-stripe-account-rejected
patch
await global.api.administrator.connect.SetStripeAccountRejected.patch(req)
/api/administrator/connect/stripe-account
get
await global.api.administrator.connect.StripeAccount.get(req)
/api/administrator/connect/stripe-accounts-count
get
await global.api.administrator.connect.StripeAccountsCount.get(req)
/api/administrator/connect/stripe-accounts
get
await global.api.administrator.connect.StripeAccounts.get(req)
URL
accountid
all
limit
offset
Top of page
${parameter.name}
${route.url}
${route.verb}
await ${route.nodejs}.${route.verb.toLowerCase()}(req)
URL
POST