Como criar um Pix Automático?
Para criar um pix Automático você utilizará o mesmo endpoint de assinatura que já existe, porém necessitará de enviar alguns campos adicionais.
Você deverá fazer uma chamada POST para o endpoint /api/v1/subscriptions
.
Como parte do body
da requisição, esperamos o envio dos seguintes itens:
value
: O valor em centavos da assinatura a ser criada.customer
: O cliente da assinatura a ser cobrado. É obrigatório o envio do endereço do cliente. Este campo é idempotente, o que significa que se você enviar dados de um cliente que já exista, utilizaremos o existente ao invés de criar um novo.type
: Deve ser definido comoPIX_RECURRING
journey
: Deve ser baseado em qual jornada escolheu utilizar (PUSH_NOTIFICATION
: Jornada 1,ONLY_RECURRENCY
: Jornada 2,PAYMENT_ON_APPROVAL
: Jornada 3,PAYMENT_WITH_OFFER_TO_RECURRENCY
: Jornada 4),retryPolicy
: Qual Política de rententativa deve ser adotada (NON_PERMITED
: Sem política de retentativas,THREE_RETRIES_7_DAYS
: 3 Retentativas em até 7 dias )comment
: A descrição da cobrança aparecerá para o seu cliente ao ler o qrcode no aplicativo do banco.
O body também aceita outros campos opcionais:
dayGenerateCharge
: Dia do mês em que as cobranças serão geradas. Deve ser um valor de 0 a 27. Caso seja escolhido a jornada 3 (PAYMENT_ON_APPROVAL
) a data da cobrança deve ser o dia atual
Exemplo
O body da sua requisição será semelhante a este exemplo:
{
"name": "Pix Automático",
"value": 100,
"customer": {
"name": "Dan",
"taxID": "31324227036",
"email": "[email protected]",
"phone": "5511999999999",
"address": {
"zipcode": "04556300",
"street": "rua de são paulo",
"number": "3432",
"neighborhood": "BROOKLIN PAULISTA",
"city": "SAO PAULO",
"state": "SP",
"complement": "CONJ 26"
}
},
"correlationID": "UniqueID",
"comment": "Comentários",
"frequency": "WEEKLY",
"type": "PIX_RECURRING",
"pixRecurringOptions": {
"journey": "PAYMENT_ON_APPROVAL",
"retryPolicy": "NON_PERMITED"
},
"dayGenerateCharge": 10,
"dayDue": 3
}
Após efetuar a requisição, se tudo ocorreu bem, o status code da requisição será 2xx
e no body
da resposta, retornaremos a assinatura criada.
Retornarmeros a seguinte resposta de exemplo:
{
"subscription": {
"customer": {
"name": "Teste",
"email": "[email protected]",
"address": {
"zipcode": "04556300",
"street": "rua de são paulo",
"number": "3432",
"neighborhood": "BROOKLIN PAULISTA",
"city": "SAO PAULO",
"state": "SP",
"complement": "CONJ 26",
"country": "BR",
"location": {
"coordinates": []
},
"_id": "689cafe1d7943ac642518543"
},
"taxID": {
"taxID": "98800834825",
"type": "BR:CPF"
},
"correlationID": "5a85c7a3-5c54-491d-a2f9-9c1ac486fd7a"
},
"dayGenerateCharge": 13,
"value": 20,
"status": "ACTIVE",
"correlationID": "correla3tionIDptTZ23vBVtTvt3vgd4TrTvzrVTV34tz3tTtv3ttdtzvttXa5dvtrtstv23tgc43trr3rt23rdtsttx3fv4f3t53r544334ff",
"pixRecurring": {
"recurrencyId": "RN5481141720250813pVFu88V0hwA",
"emv": "00020101021226870014br.gov.bcb.pix2565qr-h.woovi.digital/qr/v2/cob/43da9720-fdfe-4a0a-87f4-6e8ef3881a325204000053039865802BR5911Pedro Woovi6007VITORIA62070503***80870014br.gov.bcb.pix2565qr-h.woovi.digital/qr/v2/rec/35c05584-4d71-410e-a815-7fb379328c466304E44D",
"journey": "PAYMENT_ON_APPROVAL"
},
"globalID": "UGF5bWVudFN1YnNjcmlwdGlvbjo2ODljYWZlMWQ3OTQzYWM2NDI1MTg1NGY="
}
}