{
  "opencollection": "1.0.0",
  "info": {
    "name": "Kanastra Banking Accounts PIX Keys API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "PIX Keys",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://banking.kanastra.com.br/api/v1/pix/:account_uuid/keys",
            "params": [
              {
                "name": "account_uuid",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint retrieves a list of keys associated with a specific account identified by account_uuid . The request allows filtering the keys based on their status and additional query parameters. Query Parameters status (optional): Filter keys based on their status. For example, setting this to ACTIVE will return only active keys. type (optional): Filter keys by their type. uuid (optional): Filter keys by their unique identifier. key (optional): Filter keys by their key value. Path Variables acc"
        },
        {
          "info": {
            "name": "Read PIX-key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://banking.kanastra.com.br/api/v1/pix/:account_uuid/key/:pix_key",
            "params": [
              {
                "name": "account_uuid",
                "value": "",
                "type": "path"
              },
              {
                "name": "pix_key",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint retrieves the details associated with a specific PIX key for a given account. It allows users to access information about the beneficiary linked to the PIX key. Path Variables account_uuid (path parameter): A unique identifier for the account from which the PIX key details are being requested. pix_key (path parameter): The specific PIX key for which the details are being fetched. Response Structure Upon a successful request, the API will return a JSON object containing the followin"
        },
        {
          "info": {
            "name": "Exclude Key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://banking.kanastra.com.br/api/v1/pix/:account_uuid/key/:pix_key",
            "params": [
              {
                "name": "account_uuid",
                "value": "",
                "type": "path"
              },
              {
                "name": "pix_key",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint is used to delete a specific PIX key associated with a given account. The operation will remove the specified key from the account's settings. Path Variables account_uuid (path parameter): The unique identifier for the account from which the PIX key will be deleted. This is a required parameter. pix_key (path parameter): The unique identifier for the PIX key that needs to be deleted. This is also a required parameter. Response Structure Upon a successful deletion, the API will retu"
        },
        {
          "info": {
            "name": "Create Document Key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://banking.kanastra.com.br/api/v1/pix/:account_uuid/key",
            "params": [
              {
                "name": "account_uuid",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows users to generate a new key for a specified financial account identified by account_uuid . To create a random key, only the type is needed. The key is generated by BACEN, and to obtain it, the account’s key listing endpoint must be queried after the request. Request Body The request requires a JSON body with the following parameter: type (string): This parameter specifies the type of key to be generated. In the provided example, the value is set to \"RANDOM\" , indicating that"
        },
        {
          "info": {
            "name": "Deny with OTP Token",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://banking.kanastra.com.br/api/v1/pix/:account_uuid/key/:pix_key_uuid",
            "params": [
              {
                "name": "account_uuid",
                "value": "",
                "type": "path"
              },
              {
                "name": "pix_key_uuid",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows you to deny a specific PIX key associated with a financial account using the provided OTP (One-Time Password) for authentication. Request Body otp_code (body parameter): A string representing the One-Time Password required for the update operation. Path Variables account_uuid (path parameter): The unique identifier for the financial account. pix_key_uuid (path parameter): The unique identifier for the PIX key that you want to update. Response Structure Upon a successful requ"
        },
        {
          "info": {
            "name": "Approve Key with OTP Token",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://banking.kanastra.com.br/api/v1/pix/:account_uuid/key/:pix_key_uuid",
            "params": [
              {
                "name": "account_uuid",
                "value": "",
                "type": "path"
              },
              {
                "name": "pix_key_uuid",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows you to approve the creation of a specific PIX key associated with a financial account using an OTP (One-Time Password) for authentication. Request Body otp_code (body parameter): A string representing the One-Time Password required for the update operation. Path Variables account_uuid (path parameter): The unique identifier for the financial account. pix_key_uuid (path parameter): The unique identifier for the PIX key that you want to update. Response Structure Upon a succes"
        },
        {
          "info": {
            "name": "Resend OTP Token",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://banking.kanastra.com.br/api/v1/pix/:account_uuid/key/:pix_key_uuid/resend-otp",
            "params": [
              {
                "name": "account_uuid",
                "value": "",
                "type": "path"
              },
              {
                "name": "pix_key_uuid",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows you to resend a One-Time Password (OTP) associated with a specific PIX key for a financial account. It is useful when the user has not received the OTP or needs to regenerate it for security purposes. Request Body otp_code (body parameter): A string representing the One-Time Password required for the update operation. Path Variables account_uuid (path parameter): The unique identifier for the financial account. pix_key_uuid (path parameter): The unique identifier for the PIX"
        }
      ]
    }
  ],
  "bundled": true
}