Guides

Exemplos de requisições

Exemplo de requisições para a API de pesquisa em lote

Suggest Edits

Solicitação de débitos em lote

Verificar a obrigatoriedade de campos na API Reference

curl --location --request POST 'https://api.b2b.usezapay.com.br/v2/vehicle/debts/batch/' \
--header 'Authorization: Basic NDg5RTI5ODg4OTM6emFwYXkxMA==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "vehicles": [
        {
            "license_plate": "ABC1234"
        },
        {
            "license_plate": "ABC1235"
        }
    ]
}'

Resultado da solicitação de débitos

{
  "id": "6798f2ec-4646-49bc-9881-134c1a89c189",
  "webhook": {
    "id": "90b6b105-6d29-4af2-8ef1-71ca2bd571d7",
    "resource": "vehicle_debt_batch",
    "version": "v2"
  },
  "fleet_id": none,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "status": "pending",
  "total_vehicles": 2,
  "processed_vehicles": 0
}

Verificação de status de processamento de lote

curl --location -g --request GET 'https://api.b2b.usezapay.com.br/v2/vehicle/debts/batch/{batch_id}/status/' \
--header 'Authorization: Basic NDg5OTI5RDg4OTM6emFwYXkxMA=='

Resposta de verificação de status do processamento da consulta em lote

{
  "batch": {
    "id": "6798f2ec-4646-49bc-9881-134c1a89c189",
    "fleet_id": none
  },
  "status": "pending",
  "total_requests": 1,
  "processed_requests": 1
}

Solicitação de resultado final do processamento

A url com o path para realização dessa pesquisa também será enviada para o webhook cadastrado. Então, poderá ver o resultado esperando a url dentro da resposta do webhook e/ou consultar diretamente nessa url em caso de termino do processamento do lote.

curl --location -g --request GET 'https://api.b2b.usezapay.com.br/v2/vehicle/debts/batch/{batch_id}/results/' \
--header 'Authorization: Basic NDgROTI5ODg4OTM6emFwYXkxMA=='

Resposta de resultado final do processamento em lote

{
  "batch": {
    "id": "6798f2ec-4646-49bc-9881-134c1a89c189",
    "fleet_id": null
  },
  "webhook": {
    "id": "90b6b105-6d29-4af2-8ef1-71ca2bd571d7",
    "resource": "vehicle_debt_batch",
    "version": "v2"
  },
  "status": "done",
  "batch_debts": {
    "ABC1234": {
      "batch_id": "ABC1234",
      "customer": {
        "email": "[email protected]",
        "phone": "11999999999"
      },
      "debts": [
        {
          "amount": 1000,
          "amount_original": 1000,
          "depends_on": [],
          "description": "Teste",
          "distinct": [],
          "due_date": "2021-02-26",
          "expiration_date": "2021-02-26",
          "fine": false,
          "has_discount": false,
          "id": "ABC1234",
          "interest": false,
          "payment_in_progress_or_finalized": false,
          "title": "Teste",
          "type": "ipva",
          "year": "2021"
        }
      ],
      "event": "vehicle_debt_found",
      "has_open_payment": false,
      "id": "ABC1234",
      "protocol": "AAAAAZP",
      "vehicle": {
        "chassis": "ABC1234",
        "document": "ABC1234",
        "license_plate": "ABC1234",
        "renavam": "ABC1234"
      }
  },
  "ABC1235": {
    "id": "663902ddae6a82a606808d6e",
    "batch_id": "7fb1c7ce-d23c-4a2d-882c-222778748c4b",
    "event": "vehicle_debt_not_found",
    "protocol": "U4L2S5ZP",
    "customer": null,
    "debts": [],
    "vehicle": {
      "license_plate": "ABC1235",
      "renavam": "1111111111",
      "chassis": "1111111111111",
      "document": "11111111111",
      "owner": null,
      "model": null,
      "color": null,
      "fabrication_year": null,
      "model_year": null
    },
    "has_open_payment": null,
    "errors": {
      "detail": "Não foram localizados débitos para o veículo informado.",
      "code": "vehicle_debt_bureau_debts_not_found"
    }
  }
}
}

❗️

Informação importante

Todos os retornos e formatos são iquais aos da consulta individual. Para mais informações sobre os retorno de cada consulta individual de débitos visitar página de débitos

Resposta do webhook quando concluído o processamento

{
  "id": "90b6b115-6d29-4af2-8ef1-71ca2bd571d6",
  "event": "vehicle_debt_batch_search_done",
  "webhook": {
    "id": "90b6b105-6d29-4af2-8ef1-71ca2bd571d7",
    "resource": "vehicle_debt_batch",
    "version": "v2"
  },
  "status": "sent",
  "data": {
    "batch_id": "6798f2ec-4646-49bc-9881-134c1a89c189",
    "url": "https://api.b2b.usezapay.com.br/v2/vehicle/debts/batch/6798f2ec-4646-49bc-9881-134c1a89c189/results/",
    "total_requested": 2
  }
}

Updated 9 months ago