BankAccount POST
Cadastra uma nova conta bancária
/bank-account
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| account_type | string | Tipo de conta: CC para Conta Corrente, CP para Conta Poupança, CD para Conta de Depósito ou PIX para PIX |
YES |
| bank_number | string | Código do Banco: Exemplo, 001 para Banco do Brasil |
YES |
| bank_agency | string | Número da Agência Bancária |
YES |
| account_number | string | Número da conta |
YES |
| account_digit | string | Digito verificador da conta bancária |
YES |
| pix_key_type | string | Tipo de chave Pix: "document" para CPF/CNPJ, "email" para email, "phone" para telefone ou "rand_key" para chave aleatória |
NO |
| pix_key | string | Chave PIX identificadora da conta |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
| Authorization | Bearer token |
Request Body
{
"account_type": "CP",
"bank_number" : "033",
"bank_agency" : "111111",
"account_number" : "222222",
"account_digit": "3"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Response Body
{
"id": "12",
"account_type": "CP",
"bank_number": "033",
"bank_agency": "111111",
"account_number": "222222",
"account_digit": "3",
"pix_key_type": null,
"pix_key": null,
"confirmed": "0",
"confirmed_at": null,
"removed": "0",
"created_at": "2022-09-24 15:48:31",
"updated_at": "2022-09-24 15:48:31"
}