Orders

openapi: 3.0.0 info: version: '0.0' title: Accounts Orders servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: Stop Payments paths: '/users/{userId}/accounts/{accountId}/stops': get: tags: - Stop Payments 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. Gets stop payments for an account security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/accounts.stops.readonly' parameters: - in: path name: userId description: ID of the desired user required: true schema: type: string - in: path name: accountId description: ID of the account required: true schema: type: string responses: '200': description: OK - Stop payments retrieved content: application/json: schema: $ref: '#/components/schemas/accountStopPayments' '403': description: User lacks ability or account lacks entitlement to read stops '500': description: Server error post: tags: - Stop Payments description: | This endpoint supports being used with an Access Token from the Admin API with "Manage everything – users, messages, settings, and organizations and organization members" permission for Associated User. Create a stop payment for an account security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/accounts.stops.readwrite' parameters: - in: path name: userId description: ID of the desired user required: true schema: type: string - in: path name: accountId description: ID of the account required: true schema: type: string requestBody: description: Create a stop payment for a single check or range of checks required: true content: application/json: schema: $ref: '#/components/schemas/stopPaymentCreate' responses: '204': description: Stop payment created successfully '403': description: Stop payment creation forbidden content: application/json: schema: $ref: '#/components/schemas/stopPaymentCreateForbidden' '500': description: Server error 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: accountStopPayments: type: object properties: stops: type: array items: $ref: '#/components/schemas/accountStopPayment' accountStopPayment: type: object required: - submittedDate - startingCheckNumber - endingCheckNumber properties: submittedDate: type: string format: date description: 'Date when the stop payment order was issued, in date-only format' example: '2012-12-05' startingCheckNumber: type: integer example: 1542 description: The single check number for a single stop or starting check number for a range stop endingCheckNumber: type: integer example: 1543 description: Ending check number for a range stop reason: type: string description: Reason text containing a pre-defined enum value as a string or free form text payee: type: string description: Payee name checkDate: type: string format: date description: 'Date of the stopped check, in date-only format' example: '2012-12-05' checkAmount: type: string description: Check amount value as text pattern: '([1-9]\d*|0)\.\d{2}' example: '25.00' stopPaymentCreate: type: object required: - startingCheckNumber properties: startingCheckNumber: type: integer example: 1542 description: The single check number for a single stop or starting check number for a range stop endingCheckNumber: type: integer example: 1543 description: Ending check number for a range stop reasonCode: type: string description: Reason code enumeration value. If `Other` is used a value for `otherReason` is expected enum: - Unknown - Lost - Stolen - Destroyed - NotEndorsed - Certified - Disputed - ReturnedMerchandise - StoppedService - Other otherReason: type: string description: Free form reason for use in conjunction with `Other` reasonCode payee: type: string description: Name of the payee checkDate: type: string format: date description: 'Date of the stopped check, in date-only format' example: '2012-12-05' checkAmount: type: string description: Check amount value as text pattern: '([1-9]\d*|0)\.\d{2}' example: '25.00' stopPaymentCreateForbidden: type: object required: - type properties: type: type: string description: Type of bad request failure enum: - InsufficientFunds - DuplicateStop - CheckCleared - NoAbility - NoEntitlement