/api/user/connect/person (GET)
await global.api.user.connect.Person.get(req) Located in Stripe Connect module API
Returns object
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 querystring personid | |
invalid-personid | missing querystring personid |
invalid-account | ineligible accessing account |
NodeJS source (edit on github)
If you see a problem with the source submit a pull request on Github.
const connect = require('../../../../../index.js')
const stripeCache = require('../../../../stripe-cache.js')
module.exports = {
get: async (req) => {
if (!req.query || !req.query.personid) {
throw new Error('invalid-personid')
}
const exists = await connect.StorageList.exists(`${req.appid}/persons`, req.query.personid)
if (!exists) {
throw new Error('invalid-personid')
}
const stripeid = await connect.Storage.read(`${req.appid}/map/personid/stripeid/${req.query.personid}`)
if (!stripeid) {
throw new Error('invalid-personid')
}
req.query.stripeid = stripeid
const stripeAccount = await global.api.user.connect.StripeAccount.get(req)
if (!stripeAccount) {
throw new Error('invalid-stripeid')
}
const accountKey = {
api_key: req.stripeKey.api_key,
stripe_account: stripeid
}
const person = await stripeCache.retrievePerson(stripeid, req.query.personid, accountKey)
if (!person) {
throw new Error('invalid-personid')
}
return person
}
}
Test source (edit on github)
Tests perform real HTTP requests against a running Dashboard server.
/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../../test-helper.js')
const TestStripeAccounts = require('../../../../../test-stripe-accounts.js')
describe('/api/user/connect/person', () => {
describe('exceptions', () => {
describe('invalid-personid', () => {
it('missing querystring personid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/connect/person')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-personid')
})
it('invalid querystring personid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/connect/person?personid=invalid')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-personid')
})
})
describe('invalid-account', () => {
it('ineligible accessing account', async () => {
const user = await TestStripeAccounts.createCompanyWithRepresentative('DE')
const user2 = await TestHelper.createUser()
const req = TestHelper.createRequest(`/api/user/connect/person?personid=${user.representative.id}`)
req.account = user2.account
req.session = user2.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-account')
})
})
})
describe('returns', () => {
it('object', async () => {
const user = await TestStripeAccounts.createCompanyWithRepresentative('DE')
const req = TestHelper.createRequest(`/api/user/connect/person?personid=${user.representative.id}`)
req.account = user.account
req.session = user.session
req.filename = __filename
req.saveResponse = true
const representative = await req.get()
assert.strictEqual(representative.id, user.representative.id)
})
})
})