> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rollfi.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# refreshUserBankAccountStatus

> ⚠️ WARNING: Sandbox Only Method. Pleaee do not include this in production flows

### Required inputs:

- `userId`: The ID of the test employee.
- `employeePayAccountId`: The ID returned when the employee's bank account was added. The account must belong to the supplied employee.

### Response:

Check that `bankAccountStatus` is `ready` or `active` before treating the account as approved.

### Notes:

- This endpoint loops through all employee bank acocunts to refresh their status. Please verify all accounts with a getUser call after hitting the endpoint
- Employee bank account verification may take up to 1 hour in sandbox. If the status still won't flip after this time please reach out to support




## OpenAPI

````yaml POST /sandbox/refreshUserBankAccountStatus
openapi: 3.1.0
info:
  title: Default module
  description: |
    Webhook events emitted when a company's KYB status is created or changes.

    Rollfi sends these requests to the webhook URL configured for the client.
    Consumers should return a successful 2xx response after accepting the event.
  version: 1.0.0
servers: []
security: []
tags:
  - name: Admin Portal
  - name: TimeOff Admin
  - name: TimeTracking Admin
  - name: TimeOff User
  - name: TimeTracking User
  - name: TimeTracking Reports
  - name: TimeOff Reports
  - name: Pay Schedule Webhooks
  - name: Pay Period Webhooks
  - name: Employee Bank Account Webhooks
  - name: Employee KYC Webhooks
  - name: Company Bank Account Webhooks
  - name: Company Webhooks
  - name: Employee Status Webhooks
  - name: Sandbox
paths:
  /sandbox/refreshUserBankAccountStatus:
    post:
      tags:
        - Sandbox
      summary: refreshUserBankAccountStatus
      description: >
        ⚠️ WARNING: Sandbox Only Method. Pleaee do not include this in
        production flows


        ### Required inputs:


        - `userId`: The ID of the test employee.

        - `userPayAccountEntityId`: The ID returned by getUser for the
        employee's linked bank accounts.


        ### Response:


        Check that `bankAccountStatus` is `ready` before treating the account as
        approved.


        ### Notes:


        - This endpoint loops through all employee bank acocunts to refresh
        their status. Please verify all accounts with a getUser call after
        hitting the endpoint

        - Employee bank account verification may take up to 1 hour in sandbox.
        If the status still won't flip after this time please reach out to
        support
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                method:
                  type: string
                  default: refreshUserBankAccountStatus
                userId:
                  type: string
                  format: uuid
                  description: The ID of the sandbox employee.
                userPayAccountEntityId:
                  type: string
                  format: uuid
                  description: The ID of the employee's primary active bank account.
              required:
                - method
                - userId
                - userPayAccountEntityId
            example:
              method: refreshUserBankAccountStatus
              userId: c4e7b290-1a63-4f85-b902-6d38a1e5f047
              employeePayAccountId: 3f9a6d12-8b40-4e57-a631-7c02d5b8e094
      responses:
        '200':
          description: >-
            The current bank account result or an error response. Check the
            response body rather than relying on the HTTP status alone.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  bankAccountStatus:
                    type: string
                    description: >-
                      The primary active account's status. Check for ready or
                      active; an empty value is not confirmation of approval.
                  message:
                    type: string
                  error:
                    type:
                      - object
                      - string
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
              examples:
                '1':
                  summary: Success
                  value:
                    success: true
                    bankAccountStatus: ready
                    message: Employee bank account status is ready.
                '2':
                  summary: Status not yet available
                  value:
                    success: true
                    bankAccountStatus: ''
                    message: Employee bank account status is .
          headers: {}
      deprecated: false
      security: []

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.