API Reference

Criar Autorização de Pix Automático

post
https://api.empresas.btgpactual.com/{companyId}/banking/collections/automatic-pix/authorization/flow
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Ambiente de sandbox

Esta API utiliza o Wiremock

📘

Headers de Sandbox

Este endpoint suporta Sandbox Headers

HeaderDescrição
x-responseControlar o tipo de resposta da API.
📘

Cobrança variável

Este endpoint suporta a criação de cobranças variáveis. A utilização ou não de uma cobrança variável é ditada pelo envio ou não do campo amount. Para mais informações, verifique a ficha técnica da API.

Ficha técnica

📘

Jornadas do Pix Automático

Esta API suporta as jornadas 1, 2 e 3 do Pix Automático.

  • Para utilizar a jornada 1 deve-se preencher o objeto opcional request
  • Para utilizar a jornada 2 não devem ser preenchidos os objetos opcionais request e immediatePix
  • Para utilizar a jornada 3 deve-se preencher o objeto opcional immediatePix

Body Params
string
required

Data do primeiro pagamento (deve respeitar um intervalo mínimo de 3 dias a partir da data atual)

string

Data prevista do último pagamento

link
object

Deve constar os dados do vínculo entre o recebedor e o devedor, exemplo: o devedor contratou um plano mensal de academia

account
object
required

Dados da conta do recebedor

number

Valor da cobrança

number

Total de pagamentos previstos (deverá ser removido caso o campo finalDate seja informado)

number

Valor mínimo para pagamento

string
enum
required

Retentativa de pagamento

Allowed:
string
enum
required

Período da autorização

Allowed:
request
object

Exclusivo para a jornada 1 (no aplicativo do banco do pagador chegará uma notificação via push para autorizar o Pix Automático)

immediatePix
object

Exclusivo para a jornada 3 (autorização por leitura de QrCode com pagamento imediato)

Responses

Updated 9 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago