/api/user/connect/set-company-executives-submitted (PATCH)
Account information like email addresses is generated with faker-js it is not real user information.
await global.api.user.connect.SetCompanyExecutivesSubmitted.patch(req)Returns object
{
"stripeid": "acct_1LEBzERj2EdKEOAG",
"object": "stripeAccount",
"accountid": "acct_af374cafc4275f8d",
"tokenUpdate": null,
"stripeObject": {
"id": "acct_1LEBzERj2EdKEOAG",
"object": "account",
"business_profile": {
"mcc": null,
"name": null,
"product_description": null,
"support_address": null,
"support_email": null,
"support_phone": null,
"support_url": null,
"url": null
},
"business_type": "company",
"capabilities": {
"card_payments": "inactive",
"transfers": "inactive"
},
"charges_enabled": false,
"company": {
"address": {
"city": null,
"country": "AU",
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"directors_provided": false,
"executives_provided": true,
"name": null,
"owners_provided": false,
"tax_id_provided": false,
"verification": {
"document": {
"back": null,
"details": null,
"details_code": null,
"front": null
}
}
},
"country": "AU",
"created": 1656075109,
"default_currency": "aud",
"details_submitted": false,
"email": null,
"external_accounts": {
"object": "list",
"data": [],
"has_more": false,
"total_count": 0,
"url": "/v1/accounts/acct_1LEBzERj2EdKEOAG/external_accounts"
},
"future_requirements": {
"alternatives": [],
"current_deadline": null,
"currently_due": [],
"disabled_reason": null,
"errors": [],
"eventually_due": [],
"past_due": [],
"pending_verification": []
},
"metadata": {},
"payouts_enabled": false,
"requirements": {
"alternatives": [],
"current_deadline": null,
"currently_due": [
"business_profile.mcc",
"business_profile.url",
"company.address.city",
"company.address.line1",
"company.address.postal_code",
"company.address.state",
"company.directors_provided",
"company.name",
"company.owners_provided",
"company.phone",
"company.registration_number",
"company.tax_id",
"directors.dob.day",
"directors.dob.month",
"directors.dob.year",
"directors.email",
"directors.first_name",
"directors.last_name",
"directors.relationship.title",
"external_account",
"owners.address.city",
"owners.address.line1",
"owners.address.postal_code",
"owners.address.state",
"owners.dob.day",
"owners.dob.month",
"owners.dob.year",
"owners.email",
"owners.first_name",
"owners.last_name",
"owners.relationship.percent_ownership",
"owners.relationship.title",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.city",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.line1",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.postal_code",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.state",
"person_1LEBzIRj2EdKEOAG72u91gDi.dob.day",
"person_1LEBzIRj2EdKEOAG72u91gDi.dob.month",
"person_1LEBzIRj2EdKEOAG72u91gDi.dob.year",
"person_1LEBzIRj2EdKEOAG72u91gDi.email",
"person_1LEBzIRj2EdKEOAG72u91gDi.first_name",
"person_1LEBzIRj2EdKEOAG72u91gDi.last_name",
"representative.address.city",
"representative.address.line1",
"representative.address.postal_code",
"representative.address.state",
"representative.dob.day",
"representative.dob.month",
"representative.dob.year",
"representative.email",
"representative.first_name",
"representative.last_name",
"representative.phone",
"representative.relationship.executive",
"representative.relationship.title",
"tos_acceptance.date",
"tos_acceptance.ip"
],
"disabled_reason": "requirements.past_due",
"errors": [],
"eventually_due": [
"business_profile.mcc",
"business_profile.url",
"company.address.city",
"company.address.line1",
"company.address.postal_code",
"company.address.state",
"company.directors_provided",
"company.name",
"company.owners_provided",
"company.phone",
"company.registration_number",
"company.tax_id",
"directors.dob.day",
"directors.dob.month",
"directors.dob.year",
"directors.email",
"directors.first_name",
"directors.last_name",
"directors.relationship.title",
"external_account",
"owners.address.city",
"owners.address.line1",
"owners.address.postal_code",
"owners.address.state",
"owners.dob.day",
"owners.dob.month",
"owners.dob.year",
"owners.email",
"owners.first_name",
"owners.last_name",
"owners.relationship.percent_ownership",
"owners.relationship.title",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.city",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.line1",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.postal_code",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.state",
"person_1LEBzIRj2EdKEOAG72u91gDi.dob.day",
"person_1LEBzIRj2EdKEOAG72u91gDi.dob.month",
"person_1LEBzIRj2EdKEOAG72u91gDi.dob.year",
"person_1LEBzIRj2EdKEOAG72u91gDi.email",
"person_1LEBzIRj2EdKEOAG72u91gDi.first_name",
"person_1LEBzIRj2EdKEOAG72u91gDi.last_name",
"representative.address.city",
"representative.address.line1",
"representative.address.postal_code",
"representative.address.state",
"representative.dob.day",
"representative.dob.month",
"representative.dob.year",
"representative.email",
"representative.first_name",
"representative.last_name",
"representative.phone",
"representative.relationship.executive",
"representative.relationship.title",
"tos_acceptance.date",
"tos_acceptance.ip"
],
"past_due": [
"business_profile.mcc",
"business_profile.url",
"company.address.city",
"company.address.line1",
"company.address.postal_code",
"company.address.state",
"company.directors_provided",
"company.name",
"company.owners_provided",
"company.phone",
"company.registration_number",
"company.tax_id",
"directors.dob.day",
"directors.dob.month",
"directors.dob.year",
"directors.email",
"directors.first_name",
"directors.last_name",
"directors.relationship.title",
"external_account",
"owners.address.city",
"owners.address.line1",
"owners.address.postal_code",
"owners.address.state",
"owners.dob.day",
"owners.dob.month",
"owners.dob.year",
"owners.email",
"owners.first_name",
"owners.last_name",
"owners.relationship.percent_ownership",
"owners.relationship.title",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.city",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.line1",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.postal_code",
"person_1LEBzIRj2EdKEOAG72u91gDi.address.state",
"person_1LEBzIRj2EdKEOAG72u91gDi.dob.day",
"person_1LEBzIRj2EdKEOAG72u91gDi.dob.month",
"person_1LEBzIRj2EdKEOAG72u91gDi.dob.year",
"person_1LEBzIRj2EdKEOAG72u91gDi.email",
"person_1LEBzIRj2EdKEOAG72u91gDi.first_name",
"person_1LEBzIRj2EdKEOAG72u91gDi.last_name",
"representative.address.city",
"representative.address.line1",
"representative.address.postal_code",
"representative.address.state",
"representative.dob.day",
"representative.dob.month",
"representative.dob.year",
"representative.email",
"representative.first_name",
"representative.last_name",
"representative.phone",
"representative.relationship.executive",
"representative.relationship.title",
"tos_acceptance.date",
"tos_acceptance.ip"
],
"pending_verification": []
},
"settings": {
"bacs_debit_payments": {},
"branding": {
"icon": null,
"logo": null,
"primary_color": null,
"secondary_color": null
},
"card_issuing": {
"tos_acceptance": {
"date": null,
"ip": null
}
},
"card_payments": {
"decline_on": {
"avs_failure": false,
"cvc_failure": false
},
"statement_descriptor_prefix": null,
"statement_descriptor_prefix_kana": null,
"statement_descriptor_prefix_kanji": null
},
"dashboard": {
"display_name": null,
"timezone": "Etc/UTC"
},
"payments": {
"statement_descriptor": null,
"statement_descriptor_kana": null,
"statement_descriptor_kanji": null
},
"payouts": {
"debit_negative_balances": false,
"schedule": {
"delay_days": 2,
"interval": "daily"
},
"statement_descriptor": null
},
"sepa_debit_payments": {}
},
"tos_acceptance": {
"date": null,
"ip": null,
"user_agent": null
},
"type": "custom"
},
"requiresOwners": true,
"requiresDirectors": true,
"requiresExecutives": true,
"appid": "tests_1656075108",
"createdAt": "2022-06-24T12:51:51.196Z",
"updatedAt": "2022-06-24T12:51:56.634Z"
}Exceptions
These exceptions are thrown (NodeJS) or returned as JSON (HTTP) if you provide incorrect data or do not meet the requirements:
| Exception | Circumstances |
|---|---|
| invalid-account | ineligible accessing account |
| invalid-stripe-account | ineligible stripe account for individual |
| ineligible company executives are submitted | |
| invalid-stripeid | missing querystring stripeid |
| invalid querystring stripeid |
NodeJS source (view on github)
const stripeCache = require('../../../../stripe-cache.js')
const connect = require('../../../../../index.js')
const dashboard = require('@layeredapps/dashboard')
module.exports = {
patch: async (req) => {
if (!req.query || !req.query.stripeid) {
throw new Error('invalid-stripeid')
}
const stripeAccount = await global.api.user.connect.StripeAccount.get(req)
if (stripeAccount.submittedAt ||
stripeAccount.stripeObject.business_type !== 'company' ||
stripeAccount.accountid !== req.account.accountid ||
(stripeAccount.stripeObject.company && stripeAccount.stripeObject.company.executives_provided)) {
throw new Error('invalid-stripe-account')
}
if (!stripeAccount.requiresExecutives) {
throw new Error('invalid-stripe-account')
}
const accountInfo = {
company: {
executives_provided: true
}
}
const stripeAccountNow = await stripeCache.execute('accounts', 'update', req.query.stripeid, accountInfo, req.stripeKey)
await connect.Storage.StripeAccount.update({
stripeObject: stripeAccountNow
}, {
where: {
stripeid: req.query.stripeid,
appid: req.appid || global.appid
}
})
await dashboard.StorageCache.remove(req.query.stripeid)
return global.api.user.connect.StripeAccount.get(req)
}
}
Test source (view on github)
/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../../test-helper.js')
const TestStripeAccounts = require('../../../../../test-stripe-accounts.js')
describe('/api/user/connect/set-company-executives-submitted', function () {
before(TestHelper.disableMetrics)
after(TestHelper.enableMetrics)
describe('exceptions', () => {
describe('invalid-stripeid', () => {
it('missing querystring stripeid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/connect/set-company-executives-submitted')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.patch(req)
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-stripeid')
})
it('invalid querystring stripeid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/connect/set-company-executives-submitted?stripeid=invalid')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.patch(req)
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-stripeid')
})
})
describe('invalid-stripe-account', () => {
it('ineligible stripe account for individual', async () => {
const user = await TestHelper.createUser()
await TestHelper.createStripeAccount(user, {
country: 'US',
business_type: 'individual'
})
const req = TestHelper.createRequest(`/api/user/connect/set-company-executives-submitted?stripeid=${user.stripeAccount.stripeid}`)
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.patch(req)
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-stripe-account')
})
it('ineligible company executives are submitted', async () => {
const user = await TestHelper.createUser()
await TestHelper.createStripeAccount(user, {
country: 'AU',
business_type: 'company'
})
await TestHelper.submitCompanyExecutives(user)
const req = TestHelper.createRequest(`/api/user/connect/set-company-executives-submitted?stripeid=${user.stripeAccount.stripeid}`)
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.patch(req)
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-stripe-account')
})
})
describe('invalid-account', () => {
it('ineligible accessing account', async () => {
const user = await TestHelper.createUser()
await TestHelper.createStripeAccount(user, {
country: 'DE',
business_type: 'company'
})
const user2 = await TestHelper.createUser()
const req = TestHelper.createRequest(`/api/user/connect/set-company-executives-submitted?stripeid=${user.stripeAccount.stripeid}`)
req.account = user2.account
req.session = user2.session
let errorMessage
try {
await req.patch(req)
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-account')
})
})
})
describe('returns', () => {
it('object', async () => {
const user = await TestStripeAccounts.createCompanyWithExecutives('AU', 1)
const req = TestHelper.createRequest(`/api/user/connect/set-company-executives-submitted?stripeid=${user.stripeAccount.stripeid}`)
req.account = user.account
req.session = user.session
req.filename = __filename
req.saveResponse = true
const accountNow = await req.patch()
assert.strictEqual(accountNow.stripeObject.company.executives_provided, true)
})
})
})