Powered by Redocly

BankData

Rota responsável por devolver uma lista de dados bancários

SecurityoAuth2ClientCredentials
Responses
200

A list of all bank data registered in the system

400

Unable to return a list of all bank data due to validation error

404

No bank data registered in the system was found

get/api/v1/bankdata
Response samples
application/json
[
  • {
    }
]

Rota responsável por retornar uma lista de dados bancários de um usuário

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
Responses
200

A list of all bank data for a user registered in the system

400

Unable to return a list of all bank data for a user due to validation error

404

No bank data for a user registered in the system was found

get/api/v1/users/{userId}/bankdata
Response samples
application/json
[
  • {
    }
]

Rota responsável por cadastrar os dados bancários de um novo usuário

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
Request Body schema:
bankId
required
integer <int32>
agency
required
string
account
required
string
digit
required
string
Responses
200

Add a new user's bank details

400

Unable to add a new user's bank data due to validation error

post/api/v1/users/{userId}/bankdata
Request samples
{
  • "bankId": 1,
  • "agency": "1234",
  • "account": "12345-6",
  • "digit": "12345"
}
Response samples
application/json
{
  • "id": 1,
  • "agency": "10853-3",
  • "account": "4298",
  • "digit": "3123",
  • "bank": {
    }
}

Rota responsável pela devolução dos dados bancários de uma clínica

SecurityoAuth2ClientCredentials
Request
path Parameters
clinicId
required
integer <int32>
Responses
200

A list of all bank data for a clinic registered in the system

400

Unable to return a list of all bank data for a clinic due to validation error

404

No bank data for a clinic registered in the system was found

get/api/v1/clinics/{clinicId}/bankdata
Response samples
application/json
[
  • {
    }
]

Rota responsável pelo cadastro de um novo banco de uma clínica

SecurityoAuth2ClientCredentials
Request
path Parameters
clinicId
required
integer <int32>
Request Body schema:
bankId
required
integer <int32>
agency
required
string
account
required
string
digit
required
string
Responses
200

Add a new clinic's bank details

400

Unable to add a new clinic's bank data due to validation error

post/api/v1/clinics/{clinicId}/bankdata
Request samples
{
  • "bankId": 1,
  • "agency": "1234",
  • "account": "12345-6",
  • "digit": "12345"
}
Response samples
application/json
{
  • "id": 1,
  • "agency": "10853-3",
  • "account": "4298",
  • "digit": "3123",
  • "bank": {
    }
}

Rota responsável por atualizar os dados de um banco

SecurityoAuth2ClientCredentials
Request
path Parameters
bankDataId
required
integer <int32>
Request Body schema:
bankId
required
integer <int32>
agency
required
string
account
required
string
digit
required
string
Responses
200

Update a clinic's bank details

400

Unable to update a clinic's bank data due to validation error

404

No bank data registered with this id in the system was found

put/api/v1/bankdata/{bankDataId}
Request samples
{
  • "bankId": 1,
  • "agency": "4298",
  • "account": "10853-3",
  • "digit": "12353"
}
Response samples
application/json
{
  • "id": 1,
  • "agency": "10853-3",
  • "account": "4298",
  • "digit": "3123",
  • "bank": {
    }
}

Rota responsável por deletar um dado bancário

SecurityoAuth2ClientCredentials
Request
path Parameters
bankDataId
required
integer <int32>
Responses
204

Delete a bank data

400

Unable to delete a bank data due to validation error

delete/api/v1/bankdata/{bankDataId}
Response samples
application/json
{
  • "errors": [ ],
  • "httpStatus": 500
}

Rota responsável por devolver uma lista de bancos

SecurityoAuth2ClientCredentials
Responses
200

A list of all banks registered in the system

400

Unable to return a list of all banks due to validation error

404

No banks registered in the system was found

get/api/v1/bankdata/banks
Response samples
application/json
[
  • {
    }
]

Rota responsável pelo registro de um novo banco

SecurityoAuth2ClientCredentials
Request
Request Body schema:
name
required
string
code
required
integer <int32>
Responses
200

Add a new banks details

400

Unable to add a new banks due to validation error

post/api/v1/bankdata/banks
Request samples
{
  • "name": "Banco do Brasil S.A.",
  • "code": 1
}
Response samples
application/json
{
  • "id": 4,
  • "name": "Banco Itaú Unibanco S.A.",
  • "code": 341
}
➔ Next to Beneficiary