Criar Pix Recorrente

Esse endpoint cria uma cobrança Pix recorrente para pagamento.

Exemplo de Resposta - Endpoint

JSON

 {
  "id": "a10df814-5f5d-4a7f-8277-e7d6906faac9",
    "qr_code": "00020101021226810014br.gov.bcb.pix2559qr.woovi.com/qr/v2/cob/7fcb1fca-dcc2-421e-9b8a-6e9a0340dd185204000053039865802BR5909PushinPay6008CAMPINAS62070503***80810014br.gov.bcb.pix2559qr.woovi.com/qr/v2/rec/2345c1b4-1bca-4a…",
    "status": "created",
    "value": 200,
    "webhook_url": "https://oriented-lamprey-inviting.ngrok-free.app/api",
    "qr_code_base64": "Ry95NfG5XD9Vg+/pN8Sls3/wEMRlrpJjzkt5Ge0qCDqCI7Xp/atxTMkSjTp3TZC+jxS821cpl4KCxBgTUTqRiK4uBA+rOruLjiPDgPU3Enn0/Py4wvaA0IrnuHpDMfE/JEguMTd5K+xwkbfpJ9IzyjYftLCaQCDW0x+IdCmu6TRo6inDu9g/gnp1S1YZ9…",
    "webhook": null,
    "split_rules": [],
    "end_to_end_id": null,
    "payer_name": "João Silva",
    "payer_national_registration": "99999999999",

📝 Descrição dos Campos

Title

Description

Title

Campo	Tipo	Descrição
`id`	string	Identificador único da transação gerada.
`qr_code`	string	Código PIX completo no padrão EMV para ser copiado e pago manualmente.
`status`	string	Status atual da transação (`created`).
`value`	integer	Valor da cobrança em centavos de reais.
`webhook_url`	string	URL informada para receber notificações de pagamento.
`qr_code_base64`	string	Imagem do QR Code no formato base64, ideal para exibição.
`webhook`	string/null	Retorno interno do processamento da notificação enviada, se houver.
`split_rules`	array	Lista com as regras de divisão de valores (caso existam splits configurados).
`end_to_end_id`	string/null	Código identificador do PIX gerado pelo Banco Central (aparece após o pagamento).
`payer_name`	string/null	Nome do pagador, retornado após o pagamento.
`payer_national_registration`	string/null	CPF ou CNPJ do pagador, retornado após o pagamento.
`subscription_id`	string/null	Identificador único da cobrança recorrente.

Header Parameters

Authorizationstring Required

Colocar no formato Bearer TOKEN

Acceptstring Required

application/json

Content-Typestring Required

application/json

Body Parameters

valuenumber Required

Adicione o valor em centavos. O mínimo deve ser 50 centavos

frequencynumber

namestring

commentstring

pix_recurring_retry_policynumber

customerobject

Show child attributes

webhook_urlstring

Caso tenha um servidor para receber as informações de pagamento ou estorno informe aqui sua URL

promo_valueinteger

Adicione o valor em centavos. O valor deve ser inferior ao 'value'

Response

200

Object

{ "id": "a10df814-5f5d-4a7f-8277-e7d6906faac9", "qr_code": "00020101021226810014br.gov.bcb.pix2559qr.woovi.com/qr/v2/cob/7fcb1fca-dcc2-421e-9b8a-6e9a0340dd185204000053039865802BR5909PushinPay6008CAMPINAS62070503***80810014br.gov.bcb.pix2559qr.woovi.com/qr/v2/rec/2345c1b4-1bca-4a…", "status": "created", "value": 200, "webhook_url": "https://oriented-lamprey-inviting.ngrok-free.app/api", "qr_code_base64": "Ry95NfG5XD9Vg+/pN8Sls3/wEMRlrpJjzkt5Ge0qCDqCI7Xp/atxTMkSjTp3TZC+jxS821cpl4KCxBgTUTqRiK4uBA+rOruLjiPDgPU3Enn0/Py4wvaA0IrnuHpDMfE/JEguMTd5K+xwkbfpJ9IzyjYftLCaQCDW0x+IdCmu6TRo6inDu9g/gnp1S1YZ9…", "webhook": null, "split_rules": [], "end_to_end_id": null, "payer_name": "João Silva", "payer_national_registration": "99999999999", "subscription_id": "6134421-fe50-4c2f-86ce-2411243385bd" }