---
title: "Criar iniciação de pagamento ou transferência"
method: POST
path: "/{companyId}/banking/payments"
tags: ["Pagamentos"]
---

# Criar iniciação de pagamento ou transferência

`POST /{companyId}/banking/payments`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/{companyId}/banking/payments`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://id.btgpactual.com/oauth2/token` scopes: `openid empresas.btgpactual.com/payments`

## Path parameters

- `companyId` string, required: CNPJ da empresa

## Headers

- `x-idempotency-key` string

## Request body

- BankSlipPaymentBatch
  - `items` PaymentBodyComplete[]
    - union
      - object: Pagamento pix copia e cola
        - `type` 'PIX_QR_CODE', required: Tipo do pagamento
        - `detail` DetailInsideEmv, required: Detalhes da transação referente ao campo type.
          - `creditParty` PixKeyCreditParty
            - `name` string, required: Nome do detentor da chave pix
            - `taxId` string, required: CPF/CNPJ do detentor da chave pix
          - `emv` string: Chave copia e cola de pix
        - `description` string: Descrição do pagamento visível ao favorecido. Visível no comprovante.
        - `internalDescription` string: Identificação interna do pagamento. Não consta no comprovante, apenas nos eventos internos.
        - `agreementId` string: Deve assumir o valor "INDIVIDUAL_APPROVE".
        - `batchId` string: Id do lote de pagamentos.
        - `amount` number, required
        - `debitParty` object, required: Dados da parte debitada.
          - `branchCode` string: Agência. Utilizar 50.
          - `number` string: Número da conta
        - `tags` object: Objeto de uso do cliente para identificar a transação.
          - `externalId` string
        - `paymentDate` string, date, required: Data de pagamento
      - object: Pagamento pix copia e cola
        - `type` 'PIX_QR_CODE', required: Tipo do pagamento
        - `detail` DetailInsideLocation, required: Detalhes da transação referente ao campo type
          - `creditParty` PixKeyCreditParty
            - `name` string, required: Nome do detentor da chave pix
            - `taxId` string, required: CPF/CNPJ do detentor da chave pix
          - `location` string: Identificador do QR Code
        - `description` string: Descrição do pagamento visível ao favorecido. Visível no comprovante.
        - `internalDescription` string: Identificação interna do pagamento. Não consta no comprovante, apenas nos eventos internos.
        - `agreementId` string: Deve assumir o valor "INDIVIDUAL_APPROVE".
        - `batchId` string: Id do lote de pagamentos.
        - `amount` number, required
        - `debitParty` object, required: Dados da parte debitada.
          - `branchCode` string: Agência. Utilizar 50.
          - `number` string: Número da conta
        - `tags` object: Objeto de uso do cliente para identificar a transação.
          - `externalId` string
        - `paymentDate` string, date, required: Data de pagamento
      - object: Pagamento de boleto, utilities e FGTS(utilizar utilities)
        - `type` 'BANKSLIP' | 'UTILITIES', required: Tipo do pagamento
        - `detail` DetailInsideDigitableLine, required: Detalhes da transação referente ao campo type.
          - `products` PagforInfo
            - `anticipation` object, required
              - …
          - `digitableLine` string: Linha digitavel do documento a ser pago
          - `barcode` string: Código de barras do documento a ser pago
        - `description` string: Descrição do pagamento visível ao favorecido. Visível no comprovante.
        - `internalDescription` string: Identificação interna do pagamento. Não consta no comprovante, apenas nos eventos internos.
        - `agreementId` string: Deve assumir o valor "INDIVIDUAL_APPROVE".
        - `batchId` string: Id do lote de pagamentos.
        - `amount` number, required
        - `debitParty` object, required: Dados da parte debitada.
          - `branchCode` string: Agência. Utilizar 50.
          - `number` string: Número da conta
        - `tags` object: Objeto de uso do cliente para identificar a transação.
          - `externalId` string
        - `paymentDate` string, date, required: Data de pagamento
      - object: PIX manual e TED
        - `type` 'TED' | 'PIX_MANUAL', required: Tipo do pagamento
        - `detail` CreditParty, required: Detalhes da transação referente ao campo type.
          - `products` PagforInfo
            - `anticipation` object, required
              - …
          - `creditParty` CreditPartyObj, required
            - `taxId` string, required: Documento da parte creditada
            - `name` string, required: Nome da parte creditada
            - `account` AccountObj, required
              - …
        - `description` string: Descrição do pagamento visível ao favorecido. Visível no comprovante.
        - `internalDescription` string: Identificação interna do pagamento. Não consta no comprovante, apenas nos eventos internos.
        - `agreementId` string: Deve assumir o valor "INDIVIDUAL_APPROVE".
        - `batchId` string: Id do lote de pagamentos.
        - `amount` number, required
        - `debitParty` object, required: Dados da parte debitada.
          - `branchCode` string: Agência. Utilizar 50.
          - `number` string: Número da conta
        - `tags` object: Objeto de uso do cliente para identificar a transação.
          - `externalId` string
        - `paymentDate` string, date, required: Data de pagamento
      - object: Pix por chave pix
        - `type` 'PIX_KEY', required: Tipo do pagamento
        - `detail` PixData, required: Detalhes da transação referente ao campo type.
          - `creditParty` PixKeyCreditParty, required
            - `name` string, required: Nome do detentor da chave pix
            - `taxId` string, required: CPF/CNPJ do detentor da chave pix
          - `key` KeyObj, required
            - `value` string, required: Chave Pix
        - `description` string: Descrição do pagamento visível ao favorecido. Visível no comprovante.
        - `internalDescription` string: Identificação interna do pagamento. Não consta no comprovante, apenas nos eventos internos.
        - `agreementId` string: Deve assumir o valor "INDIVIDUAL_APPROVE".
        - `batchId` string: Id do lote de pagamentos.
        - `amount` number, required
        - `debitParty` object, required: Dados da parte debitada.
          - `branchCode` string: Agência. Utilizar 50.
          - `number` string: Número da conta
        - `tags` object: Objeto de uso do cliente para identificar a transação.
          - `externalId` string
        - `paymentDate` string, date, required: Data de pagamento
      - object: DARF
        - `type` 'DARF', required: Tipo do pagamento
        - `detail` DARFdetail, required: Detalhes da transação referente ao campo type.
          - `taxPayer` TaxPayerObj, required
            - `id` string, required: Número do documento do pagador
            - `name` string, required: Nome do pagador
          - `feeAmount` number: Custo de operação
          - `expireDate` string, date, required: Data de expiração
          - `principalAmount` number, required: valor do principal
          - `fineAmount` number: Valor da multa
          - `baselinePeriodDate` string, date, required: Período de apuração
          - `treasuryRevenueCode` string, required: Código da Receita
          - `referenceNumber` string: Número de referência
        - `description` string: Descrição do pagamento visível ao favorecido. Visível no comprovante.
        - `internalDescription` string: Identificação interna do pagamento. Não consta no comprovante, apenas nos eventos internos.
        - `agreementId` string: Deve assumir o valor "INDIVIDUAL_APPROVE".
        - `batchId` string: Id do lote de pagamentos.
        - `amount` number, required
        - `debitParty` object, required: Dados da parte debitada.
          - `branchCode` string: Agência. Utilizar 50.
          - `number` string: Número da conta
        - `tags` object: Objeto de uso do cliente para identificar a transação.
          - `externalId` string
        - `paymentDate` string, date, required: Data de pagamento
      - object: Pagamento pix copia e cola
        - `type` 'PIX_REVERSAL', required: Tipo do pagamento
        - `detail` DetailInsideE2EID, required: Detalhes da transação referente ao campo type.
          - `originalEndToEndId` string, required: Chave copia e cola de pix
        - `description` string: Descrição do pagamento visível ao favorecido. Visível no comprovante.
        - `internalDescription` string: Identificação interna do pagamento. Não consta no comprovante, apenas nos eventos internos.
        - `agreementId` string: Deve assumir o valor "INDIVIDUAL_APPROVE".
        - `batchId` string: Id do lote de pagamentos.
        - `amount` number, required
        - `debitParty` object, required: Dados da parte debitada.
          - `branchCode` string: Agência. Utilizar 50.
          - `number` string: Número da conta
        - `tags` object: Objeto de uso do cliente para identificar a transação.
          - `externalId` string
        - `paymentDate` string, date, required: Data de pagamento
      - object: Pagamento pix copia e cola
        - `type` 'PIX_QR_CODE', required: Tipo do pagamento
        - `detail` DetailInsideAutomatic, required: Detalhes da transação referente ao campo type.
          - `creditParty` PixKeyCreditParty
            - `name` string, required: Nome do detentor da chave pix
            - `taxId` string, required: CPF/CNPJ do detentor da chave pix
          - `emv` string: Chave copia e cola de pix
          - `recurrences` object
            - `allowOverdraftUsage` boolean, required: Permite o uso de cheque especial
            - `shouldNotifyScheduling` boolean, required: Notifica o cliente sobre o agendamento
            - `maxAmount` number: Valor máximo da transação
        - `description` string: Descrição do pagamento visível ao favorecido. Visível no comprovante.
        - `internalDescription` string: Identificação interna do pagamento. Não consta no comprovante, apenas nos eventos internos.
        - `agreementId` string: Deve assumir o valor "INDIVIDUAL_APPROVE".
        - `batchId` string: Id do lote de pagamentos.
        - `amount` number, required
        - `debitParty` object, required: Dados da parte debitada.
          - `branchCode` string: Agência. Utilizar 50.
          - `number` string: Número da conta
        - `tags` object: Objeto de uso do cliente para identificar a transação.
          - `externalId` string
        - `paymentDate` string, date, required: Data de pagamento

## Response `201`

Iniciação de Pagamento

- BankSlipBatchResponse
  - `batchId` string
  - `contractGuid` string
  - `operationNeedsApproval` boolean, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos.md) - [All operations](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/llms.txt) - [OpenAPI document](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/revisions/2a24d3da114c?raw)
