Pagamentos e Transferências

A API de Pagamentos e transferências permite que você efeitue pagamentos de diversos tipos e realize transferências de PIX, TED, TEF. Esta API permite também realizar o cancelamento e a listagem dos pagamentos e transferências.

Casos de Uso

• Disponibilizar no sistema a capacidade de iniciar pagamentos.
• Monitoração dos status dos pagamentos dentro de um sistema.
• Gerenciamentos de lotes de pagamentos.

Recursos Disponíveis

Os recursos da API de pagamentos e transferências estão disponíveis no API Reference.

📘

API Reference

Pagamentos e transferências

Como funcionam os pagamentos

No ecossistema de APIs do BTG Empresas, as requisições criarão "iniciações de pagamento". Estas iniciações deverão ser aprovadas via internet banking ou aplicativo mobile pelas partes necessárias mediante respeito às questões de firmas e poderes da empresa.

Em outras palavras, ao utilizar a API o dinheiro não é movimentado instantaneamente, mas sim após a aprovação realizada via aplicativo mobile ou internet banking.

Há a possibilidade de aprovações unitárias ou em lote, assim como criação de "iniciações de pagamento" unitárias ou em lote.

Modalidades de pagamentos e transferências

A API de pagamentos de transferências oferecem uma serie de modalidades de pagamento, diferenciando entre si somente nos dados enviados no corpo da requisição dentro do objeto details e no tipo selecionado.

PIX_QR_CODE

Esta modalidade exige que seja informado dentro do details o emv, também chamado de código do copia e cola, do QR code. Esta modalidade cria uma iniciação de um pagamento ou transferência do tipo PIX.

BANKSLIP

Esta modalidade exige que seja informado dentro do details a linha digitável digitableLine do boleto a ser pago. Não aceita linhas digitáveis que se iniciam com 8

UTILITIES

Esta modalidade exige que seja informado dentro do details a linha digitável digitableLine da conta de utilidades(conta de energia, água...) ou FGTS a ser pago. Aceita linhas digitáveis que se iniciam com 8.

TED e PIX_MANUAL

Esta modalidade exige que seja informado dentro do details as informações da conta do beneficiário do pagamento ou transação. O tipo do pagamento ou transferência depende do tipo informado:

• PIX_MANUAL consiste num PIX
• TED consiste em um TED ou TEF com base no que é informado.

PIX_KEY

Esta modalidade exige que seja informado dentro do details uma chave pix válida de qualquer tipo. Origina um pagamento ou transferência do tipo PIX

DARF

Esta modalidade exige que sejam informados dentro do details as informações do documento a ser pago.

PIX_REVERSAL

Esta modalidade exige que seja informado dentro do details o originalEndToEndId do pix recebido. Esta modalidade consiste em uma devolução de pix recebido para a conta de onde se originou a transação.