Rewards

openapi: 3.0.0 info: version: '0.0' title: Accounts Rewards servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: Credit Card Rewards paths: '/users/{userId}/accounts/{accountId}/credit-card-rewards': get: tags: - Credit Card Rewards description: | This endpoint supports being used with an Access Token from the Admin API with "View everything – users, messages, settings, and organizations and organization members" permission for Associated User. Get rewards information for _Full Service Credit Card_ (FSCC) accounts by this user, then this endpoint return the Rewards fields parameters: - $ref: '#/components/parameters/UserId' - $ref: '#/components/parameters/AccountId' security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/accounts.readonly' - 'https://api.banno.com/consumer/auth/accounts.readwrite' responses: '200': description: | The `accountId` denotes a Credit Card owned by the user (denoted by the `userId`), and this user has the Rewards feature enabled. The response contains the Rewards information. content: application/json: schema: $ref: '#/components/schemas/CreditCardRewards' '400': description: The `userId` or `accountId` are not valid UUID '404': description: | Either the `userId` does not exist, or the `accountId` does not indicate any account of that user, or the account it denotes is not a full-service credit card. '500': description: Server error components: parameters: UserId: in: path name: userId description: ID of the desired user required: true schema: type: string format: uuid example: '01234567-abcd-4321-fedc-9876543210fa' AccountId: in: path name: accountId description: ID of the desired account required: true schema: type: string format: uuid example: '02345617-bacd-3421-fdce-876593401fa0' 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: CreditCardRewards: type: object properties: availablePoints: type: integer description: | Number of reward points that the user has earned with this card and may use (redeem) right now. This has discounted those points that have already been used in the promotions of this program. pointsAccruedAmount: type: integer description: | Number of reward points that the user has earned, which includes those that are currently redeemable, as well as those that the user has already earned, but that are not yet available to spend. lifetimeAccruedPoints: type: integer description: | Total number of reward points that the user has accumulated on this Credic Card Account since they opened this account. lifetimeRedeemedPoints: type: integer description: | Total number of reward points the user has used through this program, since they opened this card expiringPoints: type: integer description: | Number of reward points that are set to expire (and be lost) upon the next expiration day, given in the `expirationDate` field. expirationDate: type: string format: date description: | Date of the next expiration, at which time the quantity of points indicated in `expiringPoints` will expire and be lost. productDescription: type: string description: | Description text, written by the institution, on the Reward points program for credit cards.