1 - Cobranças

É possível gerar uma cobrança para terceiro, que utilizará o “Pix Copia e Cola” ou o Qrcode para efetivar uma transferência. Uma cobrança pode ser paga inúmeras vezes; o valor pode ou não ser fixo, podendo ser definido no momento da criação; não é possível atualizar um qrcode estático; não possui data de vencimento.

1.0 - Gerar pix cobrança

[POST] /api/v1/pix/gerarcobranca
PropriedadeDescriçãoObrigatórioTipo
AuthorizationBearer {Token Customer}SimBearer

[PAYLOAD]

PropriedadeDescriçãoObrigatórioTipo
amountValor da cobrança PixNãoNumber
descriptionDescrição da cobrançaNãoString
pix_keychave pixNãoString
{
    "amount":1000,
    "description": "Pix teste",
    "pix_key": "01234567890"
}

[RESPONSES]

CódigoDescrição
200Sucesso
PropriedadeDescriçãoTipo
successIndica se a operação foi executada com sucessoBoolean
codeCódigo de retorno da operaçãoNumber
qrcode_urlURL da imagem do QR Code geradoString
qrcode_digitableCódigo Pix Copia e Cola da cobrançaString
idIdentificador único da cobrançaString
amountValor da cobrançaNumber
descriptionDescrição da cobrançaString
description_customerDescrição exibida ao pagadorString
callback_urlURL de callback configurada para a cobrançaString
proof_urlURL do comprovante da cobrançaString
url_linkpublicoLink público para visualização da cobrançaString
taxa_amountValor da taxa aplicada à cobrançaNumber
{
  "success": true,
  "code": 200,
  "qrcode_url": "https://sandbox-storage.exemplo.com/images/3f9d7c12-8b6a-4bde-9c10-7e8f4a2d1b55/8a7d9f3c2e1b4d5f9a6c7e8b1d2f3a4b.svg",
  "qrcode_digitable": "00020126580014br.gov.bcb.pix0136f8b3c9d2-7a5e-4b1c-9d2e-123456789abc5204000053039865802BR5406100.005925EMPRESA EXEMPLO LTDA6009SAO PAULO61080100000062070503***6304ABCD",
  "id": "9f3b1d52-2d4f-4d6a-b9a1-8c7e5f3d2a10",
  "amount": "100.00",
  "description": "Recebimento de Cobrança Pix",
  "description_customer": "Deposito-1234",
  "callback_url": null,
  "proof_url": null,
  "url_linkpublico": "https://sandbox.exemplo.com/pix/9f3b1d52-2d4f-4d6a-b9a1-8c7e5f3d2a10",
  "taxa_amount": 0
}

2.0 Consultar Cobrança

[GET]/charge/{charge}

Este endpoint tem a responsabilidade de consultar a cobrança, com ou sem vencimento, e retornar os dados da cobrança.

[PAYLOAD]

PropriedadeDescriçãoObrigatórioCondiçãoTipo
charge (PathParam)ID da cobrançaSimString

[AÇÃO DO ENDPOINT

1 - Verificar o form request.

2 -> Consulta a cobrança na collection charges.

[RESPONSES]

CódigoDescrição
200Cobrança encontrada
404Cobrança não encontrada
422Requisição inválida
{
   "success": true,
   "message": "Cobrança consultada com sucesso",
   "data": {
    "calendar":{
            "expiration":3600
    },
    "txid":"7978c0c97ea847e78e8849634473c1f1",
    "status":"active",
    "payer":{
            "name":"José da Silva",
            "document":"18992758071"
    },
    "receiver":{
            "name":"José da Silva",
            "city":"",
            "key":"",
            "address":"",
            "zipcode": "",
            "state":"",
            "fantasyName":"",
            "document":"",
            "ispb":"",
            "bankAccount":"",
            "bankBranch":"",
            "typeAccount":0
    },
    "amount":{
            "original": 4099,
            "change_modality":1,            
            "reusable": 0,
    },
    "message":"Solicitação ao pagador",
    "copy_paste":"pix copia e cola",
    "additional_information":[
            {
                "key":"Chave da informação adicional",
                "value":"Valor da informação adicional"
            }
    ],
    

   "_id":"8ba0178ca6eac1asd10a98sd",
   "paid_amount": "",
   "paid_at":"",
   "paid":"",
   "qrcodeFormat":"",
   "created_at":"",
   "updated_at":"",
  
   "qrCodeId":"",
   "revisionNumber" : "",
   "settlementBank":"",
   "status":0
   
   }
}
PropriedadeDescriçãoTipo
successBooleano que identifica o sucesso ou não da geração.Boolean
messageMensagem de retorno sobre a geração da cobrança.String
dataMapa com informaçõesMapa
data.errCodeCódigo do erro veja “Domínios 1.0 - Domínios de erros”String

{
    "success":false,
    "message": "Conta não encontrada",
    "data":{
        "errCode":"G404"   
    }
    
}