Iniciar um pagamento

Fala, desenvolvedor! Desta vez vou mostrar pra você como criar uma iniciação de pagamento por meio da API de pagamentos do BTG Pactual Empresas!

Importante

• A API de pagamentos não transfere dinheiro imediatamente entre contas.
• Visite O que são os pagamentos? para conhecer o ciclo de vida dos pagamentos
• Operamos por meio da criação de uma iniciação de pagamento que necessita ser aprovada manualmente na conta. Até o presente momento, uma API de pagamentos ou transferências pré-aprovados ou API de aprovação não estão disponíveis
• Para ver mais informações sobre pagamentos, visite nossa página na documentação: Criar iniciação de pagamento

Escopos

Para acessar os produtos desta API, é necessário que sejam enviados os seguintes escopos:

Fluxo autorização

Essa API utiliza o Access Token obtido através do Auth Code Flow. Temos um tutorial de como você gera esse código e gera um Access Token com ele Aqui

Endpoint

Campo companyId

Esse dado é o CNPJ da conta que deseja operar. Muito provavelmente é sua ou do seu empregador direto. No ambiente de sandbox é utilizado um companyId pré determinado 30306294000145, facilitando assim o processo de teste de contratos.

Iniciando

Para iniciarmos um pagamento, basta:

• Configurar a authorização para bearer token e passar nosso Access Token válido;
• Realizar uma requisição POST para o endpoint passando o companyId correto;
• Enviar no body os dados referentes ao pagamento que deseja realizar, seguindo o formato descrito na API Reference:

Por exemplo, o pagamento de um boleto:

{
    "items": [
        {
            "type": "BANKSLIP",
            "amount": 10.2,
            "paymentDate": "2025-09-25",
            "debitParty": {
                "branchCode": "50",
                "number": "004006402"
            },
            "detail": {
                "digitableLine": 000090000031490086000643008942047004810000001000"
            },
            "tags": {
                "externalId": "item-1"
            }
        }
    ],
}

Ao realizar essa requisição, obtemos como resposta, em caso de iniciação de pagamento criada com sucesso: