---
updatedAt: 2026-05-14T14:32:15.000Z
agentTools:
  projectIndex: https://docs.oysterhr.com/v0.1/llms.txt
---

# Retrieve bank account rulesets

Returns rulesets.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Endpoints",
    "version": "v0.1"
  },
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "paths": {
    "/v0.1/bank_accounts/rulesets": {
      "get": {
        "summary": "Retrieve bank account rulesets",
        "tags": [
          "Bank Accounts"
        ],
        "description": "Returns rulesets.",
        "security": [
          {
            "bearer_auth": [
              "read"
            ]
          }
        ],
        "parameters": [
          {
            "name": "per_page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "currency_code",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "country_code",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "engagement_type",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful",
            "content": {
              "application/json": {
                "examples": {
                  "Successful": {
                    "value": {
                      "data": [
                        {
                          "rulesetId": "BRL-BR",
                          "scope": {},
                          "schemas": {
                            "post": {
                              "type": "object",
                              "properties": {
                                "engagementId": {
                                  "type": "string"
                                },
                                "isPrimary": {
                                  "type": "boolean"
                                },
                                "useForExpenses": {
                                  "type": "boolean"
                                },
                                "currencyCode": {
                                  "type": "string",
                                  "pattern": "^[A-Z]{3}$"
                                },
                                "countryCode": {
                                  "type": "string",
                                  "pattern": "^[a-zA-Z]{2}$"
                                },
                                "details": {
                                  "type": "object",
                                  "properties": {
                                    "accountNumber": {
                                      "title": "Account number",
                                      "type": "string",
                                      "pattern": "^[0-9]{4,12}(-)?[0-9Xx]$"
                                    },
                                    "branchCode": {
                                      "title": "Branch code",
                                      "type": "string",
                                      "pattern": "^[0-9]{4}$"
                                    },
                                    "swiftBicCode": {
                                      "title": "SWIFT/BIC",
                                      "type": "string",
                                      "pattern": "^([A-z0-9]{8}|[A-z0-9]{11})$"
                                    },
                                    "bankCode": {
                                      "title": "Bank code",
                                      "type": "string",
                                      "pattern": "^[0-9]{3}$"
                                    },
                                    "bankAccountName": {
                                      "title": "Account holder name (exactly as defined on your bank account)",
                                      "type": "string",
                                      "pattern": "^[A-z0-9 .,()_'-/]{1,255}$"
                                    },
                                    "recipientStreet": {
                                      "title": "Recipient street",
                                      "type": "string",
                                      "pattern": "^[A-z0-9 .,()_'-/]{1,200}$"
                                    },
                                    "recipientCity": {
                                      "title": "Recipient city",
                                      "type": "string",
                                      "pattern": "^[A-z0-9 .,()_'-/]{1,50}$"
                                    },
                                    "recipientStateOrProvince": {
                                      "title": "Recipient state or province",
                                      "type": "string",
                                      "pattern": "^[A-z0-9 .,()_'-/]{1,50}$"
                                    },
                                    "recipientZipPostCode": {
                                      "title": "Recipient zip post code",
                                      "type": "string",
                                      "pattern": "^[A-z0-9 .,()_'-/]{1,15}$"
                                    },
                                    "recipientCountry": {
                                      "title": "Recipient country",
                                      "type": "string",
                                      "pattern": "^[A-Z]{2}$"
                                    },
                                    "beneficiaryIdentificationType": {
                                      "title": "Beneficiary identification type",
                                      "enum": [
                                        "CPF",
                                        "CNPJ"
                                      ]
                                    },
                                    "beneficiaryIdentificationValue": {
                                      "title": "Beneficiary identification value",
                                      "type": "string",
                                      "pattern": "^[0-9.-]{11,20}$"
                                    }
                                  },
                                  "required": [
                                    "accountNumber",
                                    "branchCode",
                                    "bankCode",
                                    "bankAccountName",
                                    "recipientStreet",
                                    "recipientCity",
                                    "recipientCountry",
                                    "beneficiaryIdentificationType",
                                    "beneficiaryIdentificationValue"
                                  ]
                                }
                              },
                              "required": [
                                "engagementId",
                                "isPrimary",
                                "currencyCode",
                                "countryCode",
                                "details"
                              ]
                            },
                            "patch": {
                              "type": "object",
                              "properties": {
                                "isPrimary": {
                                  "type": "boolean"
                                },
                                "useForExpenses": {
                                  "type": "boolean"
                                }
                              },
                              "required": []
                            }
                          }
                        }
                      ],
                      "meta": {
                        "items": 10,
                        "count": 1,
                        "page": 1,
                        "pages": 1,
                        "firstUrl": "/v0.1/bank_accounts/rulesets?perPage=10&page=1&currencyCode=BRL&countryCode=BR&engagementType=employment",
                        "lastUrl": "/v0.1/bank_accounts/rulesets?perPage=10&page=1&currencyCode=BRL&countryCode=BR&engagementType=employment",
                        "pageUrl": "/v0.1/bank_accounts/rulesets?perPage=10&page=1&currencyCode=BRL&countryCode=BR&engagementType=employment",
                        "nextUrl": "/v0.1/bank_accounts/rulesets?perPage=10&page=&currencyCode=BRL&countryCode=BR&engagementType=employment",
                        "prevUrl": "/v0.1/bank_accounts/rulesets?perPage=10&page=&currencyCode=BRL&countryCode=BR&engagementType=employment"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oysterhr.com",
      "description": "Production server"
    },
    {
      "url": "https://api-sandbox.oysterhr.com",
      "description": "Sandbox server"
    }
  ]
}
```