Sign in

v1

latestOpenAPI 3.1.02026-07-24820248.4 KB

Cadastro de Pix Automático via notificação push

Endpoint para iniciar um registro Pix Automático até o Jornada 1 (notificação push direta para seu aplicativo bancário).

post/brazil/pix_automatic/initialize-enrollment/push-notification

Request body

id_customerstring required
id_subscriptionstring required
agenciastring required

Sequência de 4 caracteres

contastring required

Número da conta sem pontos ou símbolos incluindo o dígito verificador, se houver um X, substitua esse valor por 0., se houver um X, substitua esse valor por 0.

tipo_conta'CORRENTE' | 'POUPANCA' | 'PAGAMENTO' required
ispbstring

Sequência de 8 caracteres

bank_name'Itaú' | 'Nubank' | 'Caixa' | 'Bradesco' | 'Santander' | 'Mercado Pago' | 'Inter' | 'BTG' | 'Sicredi' | 'Picpay' | 'Rendimento' | 'C6 Bank' | 'Banco do Brasil' | 'Banco Bmg S.A' | 'banco Digio' | 'Banco do Nordeste do Brasil S.A.' | 'BANCO INDUSTRIAL DO BRASIL' | 'Banco PAN' | 'Banco Sofisa S.A.' | 'Banco XP S.A.' | 'Banrisul' | 'Iti' | 'RecargaPay' | 'Safra PF' | 'SÃO MIGUEL DO OESTE' | 'Sicoob' | 'STONE PAGAMENTOS S.A.' | 'Unicred' | 'Banco Mercantil do Brasil' | 'Banestes' | 'Banco de Brasilia' | 'Agibank'

Response

200

statusstring
recurrence_idstring

Example response

{
  "status": "success",
  "recurrence_id": "R111222333444555666"
}