Images

%YAML 1.2 --- openapi: 3.0.0 info: version: '0.0' title: Transaction Images servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/{API_VERSION}' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname API_VERSION: enum: - v0 default: v0 description: Version of the api to utilize tags: - name: Check Image description: Transaction check image - name: Personal Image description: User's uploaded image - name: User Data description: Update user's data paths: "/users/{userId}/accounts/{accountId}/transactions/{transactionId}/images/{imageId}": get: tags: - Personal Image description: | Returns a user-uploaded transaction image in PNG format This endpoint does not support being used with an Access Token from the Admin API. security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/transactions.images.readonly' parameters: - in: path name: userId required: true schema: "$ref": "#/components/schemas/UserId" - in: path name: accountId required: true schema: "$ref": "#/components/schemas/AccountId" - in: path name: transactionId required: true schema: "$ref": "#/components/schemas/TransactionId" - in: path name: imageId description: Id of the image required: true schema: type: string responses: '200': description: OK '404': description: Image not found "/users/{userId}/accounts/{accountId}/transactions/{transactionId}": put: tags: - User Data description: | Updates transaction data from a user (can also accept a Multipart message for image(s) upload). This endpoint does not support being used with an Access Token from the Admin API. security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/transactions.images.readwrite' parameters: - in: path name: userId required: true schema: "$ref": "#/components/schemas/UserId" - in: path name: accountId description: Id of the transaction account being updated required: true schema: "$ref": "#/components/schemas/AccountId" - in: path name: transactionId required: true schema: "$ref": "#/components/schemas/TransactionId" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/UpdatedResponse" '400': description: Malformed JSON was posted '503': description: Something went wrong or timed out while processing requestBody: content: application/json: schema: "$ref": "#/components/schemas/UpdateTags" description: The list of tags being updated required: true "/users/{userId}/accounts/{accountId}/check-image/transaction/{transactionId}": get: tags: - Check Image description: | Returns check image information for a transaction. This endpoint supports being used with an Access Token from the Admin API with the "Manage security settings" permission. security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/transactions.images.readonly' parameters: - in: path name: userId required: true schema: "$ref": "#/components/schemas/UserId" - in: path name: accountId required: true schema: "$ref": "#/components/schemas/AccountId" - in: path name: transactionId description: Id of a transaction required: true schema: "$ref": "#/components/schemas/TransactionId" responses: '200': description: Information about available transaction images. content: application/json: schema: "$ref": "#/components/schemas/CheckImagesResponse" "/users/{userId}/accounts/{accountId}/check-image/{transactionImageId}": get: tags: - Check Image description: | Returns a check image in PNG format. This endpoint supports being used with an Access Token from the Admin API with the "Manage security settings" permission. security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/transactions.images.readonly' parameters: - in: path name: userId required: true schema: "$ref": "#/components/schemas/UserId" - in: path name: accountId required: true schema: "$ref": "#/components/schemas/AccountId" - in: path name: transactionImageId required: true schema: "$ref": "#/components/schemas/TransactionImageIdV0" - in: query name: side description: the side of the check expected required: true schema: type: string enum: - front - back responses: '200': description: OK content: image/png: schema: type: string format: binary '404': description: >- Image not found. In the event of an error a description of the error might be provided if additional details about the error are available. content: application/problem+json: schema: "$ref": "#/components/schemas/RFC7807ErrorResponse" components: securitySchemes: OpenID_Connect: type: openIdConnect description: OpenID Connect - Discovery endpoint will be institution specific openIdConnectUrl: >- https://digital.garden-fi.com/a/consumer/api/v0/oidc/.well-known/openid-configuration schemas: CheckImagesResponse: type: object properties: checkImages: type: array items: "$ref": "#/components/schemas/CheckImage" CheckImage: type: object required: - id properties: id: "$ref": "#/components/schemas/TransactionImageIdV0" checkNumber: "$ref": "#/components/schemas/CheckNumber" amount: "$ref": "#/components/schemas/Amount" TransactionImageIdV0: type: string format: uuid description: Id of a transaction image UserId: type: string format: uuid description: Id for a User AccountId: type: string format: uuid description: Id of the transaction account TransactionId: type: string format: uuid description: Id of the transaction CheckNumber: type: string description: The check number Amount: type: string description: description UpdateTags: type: object properties: tags: type: array items: type: object properties: tag: type: string description: Tag being updated global: type: boolean description: If the tag is global or not globalTagRemovals: type: array items: type: object properties: tag: type: string description: Global tag removals merchant: type: object properties: id: type: string description: >- Providing a null merchantId will result in the merchant being removed from the transaction global: type: boolean description: >- Default is true. If the global flag is provided or omitted, the merchant will be removed from all similar transactions merchantId: type: string description: >- Providing a null merchantId will result in the merchant being removed from the transaction datePosted: type: string description: Update the date amount: type: integer description: Update the amount notes: type: string description: Update a note receiptImageIds: type: array items: type: string description: An empty list represents removing all receipt images checkImageIds: type: array items: type: string description: An empty list represents removing all check images UpdatedResponse: type: object required: - taskId properties: taskId: type: string description: >- TaskId for transactions/bills affected by this update. This task includes events from re-enrichment-task-events RFC7807ErrorResponse: type: object description: >- A description of the error. This value will conform to a RFC 7807 http problem. additionalProperties: true properties: title: type: string description: >- A high level description of the problem. This description will not be specific to this instance of the prbolem. detail: type: string description: >- A specific description of the problem and why it occurred.