v1

latestOpenAPI 3.1.02026-07-24280138.8 KB

Emissão de carnê

Gere um boleto parcelado através desta API

post/installments

Headers

Idempotency-Keystring required

UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro.

Request body

codestring

Código definido por você, pode ser um id do recurso no seu sistema. Nós iremos retornar esse código sempre que você consultar uma fatura.

payment_termsobject

installmentobject required

payment_formsstring[]

Response

200

document_urlstring

Example response

{
  "document_url": "https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-parcelado-cf8307e2-613e-4fa6-bf14-a5e0a0cf0edb.pdf?generation=1682450946913353&alt=media",
  "result": [
    {
      "id": "inv_X8wKS99PkRtG90yus99fQnTDw",
      "amount_total": 5000,
      "status": "OPEN",
      "document_url": "https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-efcaa0b8-5ae8-464e-b7bc-1d7c25104b4b.pdf?generation=1682450945082231&alt=media",
      "buyer": {
        "name": "Gol Transportes Aéreos S.a.",
        "document": "34052649000178",
        "email": "email@email.com",
        "type": "PJ",
        "address": {
          "street": "Rua Gomes de Carvalho",
          "number": "1629",
          "district": "Vila Olímpia",
          "city": "São Paulo",
          "state": "SP",
          "complement": "N/A",
          "zip_code": "00111222"
        }
      },
      "seller": {
        "business_id": "4138c245-50f0-4e8b-91d9-a69b5068e406",
        "name": "Test Account Company Name",
        "document": "54145456000179",
        "type": "PJ"
      },
      "bank_slip": {
        "barcode": "40399934000000050000000054145456000007808901",
        "digitable": "40390000075414545600700078089018993400000005000",
        "our_number": "41454560000078089",
        "url": "https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-efcaa0b8-5ae8-464e-b7bc-1d7c25104b4b.pdf?generation=1682450945082231&alt=media",
        "document_sequence": 78089,
        "interest_monthly_percent": 2.5,
        "fine_value": 200,
        "discount_value": 100,
        "bill_type": "REGULAR"
      },
      "services": [
        {
          "name": "Descrição Do Serviço Parcela 1/2",
          "description": "Descrição",
          "amount": 5000
        }
      ],
      "payment_terms": {
        "due_date": "2023-05-04",
        "interest": {
          "value": 250,
          "type": "PERCENT"
        },
        "fine": {
          "value": 200,
          "type": "FIXED",
          "start_at": "2023-05-05"
        },
        "discount": {
          "value": 100,
          "type": "FIXED"
        }
      },
      "payment_forms": [
        "BANK_SLIP"
      ],
      "created_at": "2023-04-25T19:29:03Z",
      "authentication_id": "null"
    }
  ]
}