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 instância de pagamento que necessita ser aprovada manualmente na conta.
  • Para ver mais informações sobre pagamentos, visite nossa página na documentação: Pagamentos.

Escopos

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

EscoposDescrição
openidConsultar perfil do usuário
empresas.btgpactual.com/paymentsPermite criar e consultar pagamentos.

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.

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 boleto que deseja pagar seguindo o formato:
{
    "items": [
        {
            "type": "BANKSLIP",
            "amount": 10.2,
            "scheduledDate": "2023-09-25",
            "debitParty": {
                "branchCode": "50",
                "number": "004006402"
            },
            "detail": {
                "digitableLine": 000090000031490086000643008942047004810000001000"
            },
            "tags": {
                "externalId": "item-1"
            }
        }
    ],
    "tags": {
        "externalId": "teste-25"
    }
}
PostPag-1

Ao realizar essa requisição, obtemos como resposta:

PostPag-2

O externalIdé uma informação importante para futuras requisições. De brinde, a API ainda nos devolveu montada a requisição que exemplificamos em Listar um pagamento aprovado específico!


Postman

Temos uma collection do postman com todas as requests mais utilizadas e demandadas pelos nossos clientes. Para encontra-lá basta visitar nossa página Postman Collections