Ouvrir une session de consentement

POST 
/api/v1/workspaces/:workspace_id/companies/:company_id/bank_connections

Ouvre une session de consentement et retourne la connexion en pending avec une consent_url. Un 201 signifie qu'une session existe, jamais qu'une banque est connectée. Un humain doit ouvrir consent_url dans un navigateur ; il n'existe pas de connexion bancaire sans navigateur. Interrogez GET /api/v1/bank_connections/{id} après le retour de l'utilisateur - un connected signifie qu'un événement ou une synchronisation l'a confirmé, ce que la redirection ne fait jamais.

Request

Responses

201

Une session de consentement a été ouverte. La connexion est en pending et consent_url porte la page que l'utilisateur doit visiter.

202

La réponse de l'agrégateur n'a pas établi si une session avait été ouverte. La connexion vous est rendue pour que vous puissiez l'interroger, sans consent_url - il n'y en a pas à donner. Interrogez GET /api/v1/bank_connections/{id} ; si elle est toujours en pending passé consent_url_expires_at, ouvrez une nouvelle session avec une Idempotency-Key neuve. Rejouer cette clé vous rend cette même réponse au lieu d'ouvrir une seconde session.

409

Cette Idempotency-Key ne peut pas servir cette requête. code dit laquelle des deux raisons. idempotency_key_reuse - la clé a déjà servi pour un corps différent, alors envoyez une clé neuve, ou renvoyez le corps d'origine pour rejouer la réponse mémorisée. idempotency_request_in_progress - un appel antérieur portant cette clé est encore en cours, ou s'est terminé sans établir que rien n'avait quitté la plateforme. Dans les deux cas, cet appel-ci n'a rien écrit.

422

La requête a été refusée. code dit laquelle des quatre raisons. validation_failed - l'en-tête Idempotency-Key ou le champ user_email manque. invalid_argument - l'user_email est mal formé, ou redirect_url ne fait pas partie des URI enregistrées pour votre application. provider_quota_exceeded - l'agrégateur refuse d'ouvrir une connexion de plus pour ce compte, alors libérez une place ou changez d'offre, car réessayer à l'identique sera refusé de nouveau. operation_failed - l'agrégateur a refusé la session pour un motif transitoire, ou une autre session est déjà en cours d'ouverture pour la même entreprise, alors réessayez.