|
3917 | 3917 | } |
3918 | 3918 | } |
3919 | 3919 | }, |
| 3920 | + "/companies/{companyId}/connections/{connectionId}/bankFeeds/otp": { |
| 3921 | + "parameters": [ |
| 3922 | + { |
| 3923 | + "$ref": "#/components/parameters/companyId" |
| 3924 | + }, |
| 3925 | + { |
| 3926 | + "$ref": "#/components/parameters/connectionId" |
| 3927 | + } |
| 3928 | + ], |
| 3929 | + "post": { |
| 3930 | + "tags": [ |
| 3931 | + "Source accounts" |
| 3932 | + ], |
| 3933 | + "summary": "Generate one-time password", |
| 3934 | + "description": "The *Generate OTP* endpoint generates a one-time password (OTP) for a bank feed connection. The OTP is returned along with an expiry time, after which it will no longer be valid.\n\n> **For Sage only**\n>\n> Only call this endpoint for connections to Sage. Calling it for other integrations will return an error.\n", |
| 3935 | + "operationId": "generate-otp", |
| 3936 | + "responses": { |
| 3937 | + "200": { |
| 3938 | + "description": "Success", |
| 3939 | + "content": { |
| 3940 | + "application/json": { |
| 3941 | + "schema": { |
| 3942 | + "$ref": "#/components/schemas/GenerateOtpResponse" |
| 3943 | + }, |
| 3944 | + "examples": {} |
| 3945 | + } |
| 3946 | + } |
| 3947 | + }, |
| 3948 | + "400": { |
| 3949 | + "$ref": "#/components/responses/BadRequest" |
| 3950 | + }, |
| 3951 | + "401": { |
| 3952 | + "$ref": "#/components/responses/Unauthorized" |
| 3953 | + }, |
| 3954 | + "402": { |
| 3955 | + "$ref": "#/components/responses/Payment-Required" |
| 3956 | + }, |
| 3957 | + "403": { |
| 3958 | + "$ref": "#/components/responses/Forbidden" |
| 3959 | + }, |
| 3960 | + "404": { |
| 3961 | + "$ref": "#/components/responses/Not-Found" |
| 3962 | + }, |
| 3963 | + "429": { |
| 3964 | + "$ref": "#/components/responses/Too-Many-Requests" |
| 3965 | + }, |
| 3966 | + "500": { |
| 3967 | + "$ref": "#/components/responses/Internal-Server-Error" |
| 3968 | + }, |
| 3969 | + "503": { |
| 3970 | + "$ref": "#/components/responses/Service-Unavailable" |
| 3971 | + } |
| 3972 | + } |
| 3973 | + } |
| 3974 | + }, |
3920 | 3975 | "/companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions": { |
3921 | 3976 | "post": { |
3922 | 3977 | "tags": [ |
|
6035 | 6090 | } |
6036 | 6091 | } |
6037 | 6092 | }, |
| 6093 | + "GenerateOtpResponse": { |
| 6094 | + "title": "OTP response", |
| 6095 | + "type": "object", |
| 6096 | + "description": "Response containing a one-time password and its expiry time.", |
| 6097 | + "additionalProperties": false, |
| 6098 | + "properties": { |
| 6099 | + "otp": { |
| 6100 | + "type": "string", |
| 6101 | + "description": "The one-time password." |
| 6102 | + }, |
| 6103 | + "expiry": { |
| 6104 | + "$ref": "#/components/schemas/DateTime", |
| 6105 | + "description": "The expiry date and time of the OTP in UTC." |
| 6106 | + } |
| 6107 | + }, |
| 6108 | + "required": [ |
| 6109 | + "otp", |
| 6110 | + "expiry" |
| 6111 | + ], |
| 6112 | + "examples": [ |
| 6113 | + { |
| 6114 | + "otp": "GT40U4", |
| 6115 | + "expiry": "2026-04-08T10:30:00Z" |
| 6116 | + } |
| 6117 | + ] |
| 6118 | + }, |
6038 | 6119 | "PullOperation": { |
6039 | 6120 | "title": "Pull operation", |
6040 | 6121 | "description": "Information about a queued, in progress or completed pull operation.\n*Formally called `dataset`*", |
|
0 commit comments