Guide

Resolvendo pendências

Endpoint utilizado para reapresentação de pendencias de pagamento de uma operação CLT na API da V8 Digital.

Endpoint para reapresentação da chave pix da proposta

URL: https://bff.v8sistema.com/private-consignment/operation/{idOperation}/pendency/payment-data

Método HTTP: PATCH

Autenticação: Requer token JWT válido no header da requisição.

Exemplo de requisição:
{
  "bank": {
    "transfer_method": "pix",
    "pix_key": "string",
    "pix_key_type": "cpf"
  }
}
Parâmetros da Requisição

  • transfer_method string
    Metodo da tranferencia informar como “pix”

  • pix_key string
    chave pix para pagamento da operação

  • pix_key_typestring
    tipo de chave pix utilizada na operação.

Parâmetros aceitos para o pix_key_type:

  • cpf string

    CPF do titular da operação

  • email string

    email informado pelo cliente

  • phone string
    numero do telefone incluindo codigo pais +55 e DDD

  • random string
    Chave aleatoria no formato UUID

A conta bancaria da chave pix informada deverá ser de titularidade do titular do contrato.

<scalar-heading level="7" slug="" uid=""><strong>...</strong></scalar-heading>

URL: https://bff.v8sistema.com/file/upload/private-consignment

Método HTTP: POST

Autenticação: Requer token JWT válido no header da requisição.

<scalar-heading level="7" slug="" uid=""><strong>...</strong></scalar-heading> 
[
  {
    "key": "string",
    "file_name": "string"
  }
]
<scalar-heading level="7" slug="" uid=""><strong>...</strong></scalar-heading>

  • keystring
    chave que sera usado no endpoint de reapresentação de documentos

  • file_name string

    nome do arquivo que foi feito upload.

Documentos aceitos nos formatos PDF, JPEG, PNG, JPG

Endpoint para reapresentação da documentos

URL: https://bff.v8sistema.com/private-consignment/operation/{idOperation}/pendency/documents

Método HTTP: PATCH

Autenticação: Requer token JWT válido no header da requisição.

Exemplo de requisição:
{
  "documents": [
    {
      "type": "string",
      "side": "front",
      "key": "string"
    }
  ]
}
Parâmetros da Requisição

  • type string
    Metodo da tranferencia informar como “pix”

  • sidestring
    lado do documento que esta sendo enviado podendo ser informado como:

    • front string
      frente do documento enviado

    • back string

      verso do documento enviado

    • both string

      ambos para ser utilizado nos casos de CNH

  • keystring
    chave gerada pelo endpoint de upload de documentos.