iBaaS
  1. Batches and Billings
iBaaS
  • iBaaS
    • v1
      • Authentication
        • login webhooks
        • login
        • refresh
        • logout
      • BaaS
        • Account
          • create-description
          • Occupations
            • list
          • retrieve-from-provider
            • by-account-number
            • by-account-id
          • migrate-account
            • import-csv
            • list-account-migrated
            • create-account-in-matera
            • list-account-migration-logs
            • cancel-account
          • create
          • update
          • search
          • find
          • find-by-account-number
          • find-by-tax-id-number
          • get-balance
          • get-statement
          • inactivate
          • get-file
        • Cash In
          • make-pix-static-qr-code
          • make-pix-dynamic-qr-code
          • make-bank-slip
          • make-billing-slip
          • make-deposit
        • Cash Out
          • make-pix-transfer
          • make-pix-transfer-only-with-alias
          • make-non-priority-pix-transfer
          • make-bank-transfer
          • make-bank-slip-payment
          • make-utilities-payment
          • make-internal-transfer
          • return-internal-transfer
        • Transactions
          • get-transaction
          • get-withdraw
          • get-bank-slip-by-bar-code
          • lock-balance
          • unlock-balance
          • initiate-ted
        • Pix
          • Aliases
            • Portabilidade de Alias (Chave)
            • list
            • exclude
            • create
            • alias-verification-code
            • get-destination-alias
            • alias-portability
            • alias-portability-confirmation
            • alias-portability-cancellation
            • alias-ownership-claims
            • alias-ownership-claims-responses
            • alias-ownership-claims-cancellation
          • Med
            • iBass
              • search
              • create
              • cancel
            • list
            • search
            • find
            • create
            • sent
            • in_analysis
            • approved
            • rejected
            • cancel
            • situation-types
            • med-types
            • med-status
          • Automatic
            • Recurrence
              • List Recurrences
              • Detail Recurrence
              • Authorize Recurrence
              • Save Recurrence With Authorization
            • Billing
              • Cancel Billing Scheduled
              • List Billings Scheduled
          • get-limits
          • return-codes
          • get-participants
          • returns
          • decode-qr-code
          • text-to-qr-code
        • Cellphone Recharge
          • get-carriers
          • get-avaliable-values
          • recharge
        • Webhook
          • set-accounts-webhook
        • Limits
          • get-limits
          • request-limit-update
          • search-update-limit-requests
          • process-limit-update
        • Batches and Billings
          • Charge Report
            • generate-pdf
            • search
          • billing-slip-payers
            • search-by
            • list
            • create
            • find
            • update
            • delete
            • search
          • validate-shipment
            POST
          • shipment_file
            POST
          • send-shipment-with-json
            POST
          • download-return-file-batch-id
            GET
          • download-return-file-period
            GET
          • get-batches
            POST
          • get-batch
            GET
          • get-billings
            POST
          • get-billing
            GET
        • receipt-of-bills
          • Mudar status boleto (dev)
        • Dock
          • Catalog
            • document
          • Onboarding
            • setup-types
            • schema-and-business
            • product-processes
            • update-account
            • reg-docs
            • agree-reg-docs
            • start-instance
            • file-upload
            • pending-files
            • customer-process
            • client-proposal
            • Endpoint Sem Título
          • Account
            • get-account
            • update-status
            • list-account-entries
          • Account Manager
            • list-alias-via-account-identifier
            • create-banking-account
            • delete-banking-account
          • Pay
            • search-transfers
            • get-transfer
            • initiate-transfer
            • cancel-scheduled-transfer
          • Pix
            • create-dict-key
            • search-dicts
            • search-payments
            • send-payment
            • validate-dict
            • delete-dict-key
            • get-payment
      • Public Routers
        • validate-cnab400
  • Enums
    • PhysicalBusinessLineEnum
    • LegalBusinessLIneEnum
    • EstablishmentFormEnum
    • FinancialStatisticEnum
    • CountryEnum
    • AccountStatusEnum
    • DocumentsTypeEnum
    • MaritalStatusEnum
    • TestDataTableForPaymentSlips
    • CollectionWalletEnum
    • FineCodeEnum
    • RegistrationTypeEnum
    • Boletos
      • BillingSlipOriginTypeEnum
      • BatchBillingSlipFileTypeEnum
      • BillingSlipStatusEnum
      • OccurrenceCodeEnum
      • TitleTypeEnum
  • Esquemas
    • External Events
      • BaaS Dock
    • Ramos de Atividade
  1. Batches and Billings

send-shipment-with-json

POST
/v1/baas/process/{account_id}/send-shipment-with-json
Última modificação:2025-08-28 19:36:08

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Caminho

Parâmetros Bodyapplication/json

Exemplo
{
  "billing_instrument_description": "slip", // Obrigatório
  "slip_type": "in_cash", // Obrigatório
  "shipping_format": "print", // Obrigatório
  "wallet_code": "109", // Obrigatório
  "due_type_code": 3, // Obrigatório
  "species_code": "01", // Obrigatório
  "accepted_code": "S", // Obrigatório (S para aceito e N para não aceito)
  "partial_payment": true, // Obrigatório
  "partial_maximum_quantity": 2, // Obrigatório quando partial_payment = true
  "payer": {
    "taxid_number": "86692588111", // Obrigatório
    "taxid_country": "BRA", // Obrigatório
    "name": "Clevisson Amorim Bravo", // Obrigatório
    "email": "contabilidade.cormack@geradornv.com.br", // Obrigatório quando shipping_format = email
    "address": {
      "street": "Avenida João Valério", // Obrigatório
      "number": "474", // Obrigatório
      "complement": "Lote 1", // Opcional
      "district": "Santa Luzia", // Obrigatório
      "city": "Itacoatiara", // Obrigatório
      "state": "AM", // Obrigatório
      "zip_code": "69104018", // Obrigatório
      "country": "BRA" // Obrigatório
    }
  },
  "final_beneficiary": {
    "uuid": "b9d543fc-710c-424d-beff-1dbf00b4c616", // Obrigatório
    "exclusion_of_final_beneficiary": false // Obrigatório quando for para excluir o benefeciario final
  },
  "individual_data_bill": [
    {
      "total_amount": "9.38", // Obrigatório
      "due_date": "2025-09-17", // Obrigatório
      "payment_deadline": "2025-10-17", // Opcional
      "text_your_number" : "ABC1234567" // Opcional
    }
  ],
  "fees": {
    "interest_type_code": "90", // Obrigatório
    "amount_of_interest_days": 1, // Opcional
    "interest_value": "1.23", // Opcional
    "interest_percentage": "1.23", // Opcional
    "interest_date": "2025-09-11" // Opcional
  },
  "fine": {
    "code_type_fine": "01", // Obrigatório
    "number_of_days_fine": 1, // Opcional
    "amount_of_fine": "1.35", // Opcional
    "percentage_of_fine": "1.25" // Opcional
  },
  "discount": {
    "discount_type_code": "01", // Obrigatório
    "discounts": [
      {
        "discount_date": "2025-09-16", // Opcional
        "discount_value": "1.55", // Opcional
        "discount_percentage": "1.52" // Opcional
      }
    ]
  },
  "billing_instruction": [
    {
      "billing_instruction_code": "02", // Opcional
      "number_of_billing_instruction_days": 10, // Opcional
      "useful_day": true // Opcional
    }
  ],
  "protest": {
    "protest": true, // Opcional
    "protest_type_code": 1, // Opcional
    "number_of_protest_days": 1, // Opcional
    "bankruptcy_protest": true // Opcional
  },
  "negativation": {
    "negativation": true, // Opcional
    "code_type_negation": 1, // Opcional
    "amount_of_negative_days": 2 // Opcional
  },
  "divergent_receipt": {
    "authorization_type_code": 1, // Obrigatório
    "receipt_type_code": "V", // Opcional
    "minimum_value": "999999999999999.00", // Opcional
    "minimum_percentage": "9999999.00000", // Opcional
    "maximum_value": "999999999999999.00", // Opcional
    "maximum_percentage": "9999999.00000" // Opcional
  },
  "allowed_actions": {
    "issue_second_copy": true, // Opcional e
    "command_instruction_change_billing_data": true // Opcional e
  }
}

Respostas

🟢200Success
application/json
Body

Examples
{
    "status": "processing",
    "message": "Processando boletos."
}
🟠400Error
Página anterior
shipment_file
Próxima página
download-return-file-batch-id
Built with