Depósito de CCB's (Auth : x-api-token)

application/json

text/json

application/*+json

Request Body

Dados da CCB

sendToSignature boolean

Envia a CCB para fluxo de assiantura

batchName string nullable

Nome do Evento de assinatura

webhook object

headerName string nullable

Nome da Chave, Exemplo: api-token

headerValue string nullable

Valor da Chave

webhookUrl string nullable

Url do Webhook

bankCreditNotes object[] nullable

Dados da CCB

Array [

issueDate date-time

Data de Emissão

documentNumber string nullable

Número do Documento

takerVatNumber string nullable

Número de Documento do Tomador

documentBankCreditNoteId uuid

Id do Documento de CCB

value double

Valor da CCB

]

signers object[] nullable

Dados dos assinantes da CCB

Array [

email string nullable

phoneNumber string nullable

Numero de telefone

name string nullable

Nome

vatNumber string nullable

CPF

signType string nullable

Tipo de Assinatura, exemplo: PROCURADOR, EMITENTE, GESTOR, REPRESENTANTE, ETC ...

]

Responses

Success

text/plain

application/json

text/json

Schema

Example (from schema)

Schema

success boolean

errors object[] nullable

Array [

propertyName string nullable

errorMessage string nullable

attemptedValue nullable

customState nullable

severity int32

Possible values: [0, 1, 2]

errorCode string nullable

formattedMessagePlaceholderValues object nullable

nullable

]

id nullable

url string nullable

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ],
  "url": "string"
}

Schema

Example (from schema)

Schema

success boolean

errors object[] nullable

Array [

propertyName string nullable

errorMessage string nullable

attemptedValue nullable

customState nullable

severity int32

Possible values: [0, 1, 2]

errorCode string nullable

formattedMessagePlaceholderValues object nullable

nullable

]

id nullable

url string nullable

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ],
  "url": "string"
}

Schema

Example (from schema)

Schema

success boolean

errors object[] nullable

Array [

propertyName string nullable

errorMessage string nullable

attemptedValue nullable

customState nullable

severity int32

Possible values: [0, 1, 2]

errorCode string nullable

formattedMessagePlaceholderValues object nullable

nullable

]

id nullable

url string nullable

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ],
  "url": "string"
}

Bad Request

text/plain

application/json

text/json

Schema

Example (from schema)

Schema

success boolean

errors object[] nullable

Array [

propertyName string nullable

errorMessage string nullable

attemptedValue nullable

customState nullable

severity int32

Possible values: [0, 1, 2]

errorCode string nullable

formattedMessagePlaceholderValues object nullable

nullable

]

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ]
}

Schema

Example (from schema)

Schema

success boolean

errors object[] nullable

Array [

propertyName string nullable

errorMessage string nullable

attemptedValue nullable

customState nullable

severity int32

Possible values: [0, 1, 2]

errorCode string nullable

formattedMessagePlaceholderValues object nullable

nullable

]

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ]
}

Schema

Example (from schema)

Schema

success boolean

errors object[] nullable

Array [

propertyName string nullable

errorMessage string nullable

attemptedValue nullable

customState nullable

severity int32

Possible values: [0, 1, 2]

errorCode string nullable

formattedMessagePlaceholderValues object nullable

nullable

]

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ]
}

Unauthorized

text/plain

application/json

text/json

Schema

Example (from schema)

Schema

type string nullable

title string nullable

status int32 nullable

detail string nullable

instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

Schema

type string nullable

title string nullable

status int32 nullable

detail string nullable

instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

Schema

type string nullable

title string nullable

status int32 nullable

detail string nullable

instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Forbidden

text/plain

application/json

text/json

Schema

Example (from schema)

Schema

type string nullable

title string nullable

status int32 nullable

detail string nullable

instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

Schema

type string nullable

title string nullable

status int32 nullable

detail string nullable

instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

Schema

type string nullable

title string nullable

status int32 nullable

detail string nullable

instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Not Found

text/plain

application/json

text/json

Schema

Example (from schema)

Schema

type string nullable

title string nullable

status int32 nullable

detail string nullable

instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

Schema

type string nullable

title string nullable

status int32 nullable

detail string nullable

instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

Schema

type string nullable

title string nullable

status int32 nullable

detail string nullable

instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Depósito de CCB's (Auth : x-api-token)​

Depósito de CCB's (Auth : x-api-token)