Documentação da API Pix Digipag

Bem-vindo à documentação da API Pix do Digipag! Esta API permite que você integre facilmente a funcionalidade de geração de Pix em seus aplicativos.

Como Usar

Para usar a API Pix do Digipag, faça uma requisição HTTP POST para o endpoint https://api.digipag.app/v1/gateway/ com os seguintes parâmetros:

Exemplo de Requisição Cash in


{
    "amount": 100,
    "client": {
        "name": "Maria Oliveira",
        "document": "123456789",
        "telefone": "11999999999",
        "email": "maria.oliveira@email.com"
    },
    "api-key": "81bb141jmdaw9u32-d3q9md3qd-qdwq59",
    "postback": "https://meusistema.com/callback"
}

Respostas da API

Exemplo de Resposta (200 OK)

Aqui está um exemplo de resposta quando a requisição é bem-sucedida: 


{
    "status": "success",
    "message": "ok",
    "paymentCode": "00020101021226790014br.gov.bcb.pix255/v2/be1920df6b714e4e84edd77d7f25204000039865802BR592**63042CA1",
    "idTransaction": "52fc5262-4063-4900-933b-55e69850",
    "paymentCodeBase64": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAACwElEQVR4Xu2XS5IjIQwF4SJw/1vMUeAiMJmi2y57IjpmMaXZGH+qDLl4IelJ5bJ/Xr/K+87b+gBnfYCzPsBZfweMUuoqpfTVGl91r9Knm4nA5D36Xn3uUQdY5epmJhA/Fyedr9IHMuvZTAXmnopDHRurtP4fgNVMUCuuvglbNsAbFlZQERo8cI22piU9dFaE8oCVMd2xTXdUiFNGHmlArQtNdWvWt1+gT6LNgHAL7SwOkImuRr8JHo9E/CwlGifvJp6Q2omQPNgktTTRzuVg8YwcSJwzGoHp04QSdUM4YfIFCDMs8ItJgt1DNpcQNsSoeKhTUTR12QlADHPqFalEaViM1FwzwV4tunhWW3DiLONXYxzP3BqxEihi/Ph3TVZCcBSm56xmYO0GsnSwGmAvZuzPkkaVYs8fPyWrNuBKFfaCG3MUzV688zm/YBPeYoM04waWp0umYBmDVHW67R+SuQrE0AXEeo2T2Ryt2K6PJOVACixEq0RMi3iYRvZD5EJgF3UyVQxcGSCWynmEo1seZtpm1dzJsAGJe9eJsgrmSvjhd33w5MI2UjnR51h+s+P/MATYN3BVX8Z7IygBpRIkfNcTo0Lum6uvt2wKaBJiITIns0ESOWClisyDqPOGBEimR5lAWMavOSIlYGLc5fknU7gGHCq9HMCNlQYDgoD1ihyOE+zVgkr3roSi5Pm8ybxSgRc9q+4MFOV/DLcE4BxikTbVP+H2sot2UeyEoBTG+wstVHA54ZPIhDaCt4hV8dBoTsbmOEZg7X0TPw329nAiL7lvUYySnJ5wHamEqvwSsgdPvBIZAGRGTSW+vVvmHg1e0ki8NP6AGd9gLM+wFn/APgNfNIphReCMrQAAAAASUVORK5CYII="
}

Exemplo de Resposta (401 Unauthorized)

Aqui está um exemplo de resposta quando as credenciais são inválidas: 


{
    "status": "error",
    "message": "Falha na solicitação: Credenciais inválidas"
}

Confirmação de Pagamento

Para confirmar o pagamento, faça uma requisição HTTP POST para o endpoint https://api.digipag.app/v1/webhook/ com o seguinte parâmetro:

Parâmetros da Requisição


{
    "idtransaction": "81bb141a-1746-49a8-bb4a-c3b8aa0d2259"
}

Exemplo de Resposta (200 OK)

será retornado:


{
    "status": "WAITING_FOR_APPROVAL" 
    // ou
    "status": "PAID_OUT"
}

Exemplo de Resposta (400 Bad Request)

Aqui está um exemplo de resposta quando a requisição é inválida: 


{
    "error": "Invalid JSON or missing externalreference"
}

Exemplo de Resposta (404 Not Found)

Aqui está um exemplo de resposta quando a referência externa não é encontrada: 


{
    "error": "Transaction not found"
}

Exemplo de Requisição Cash Out

Endpoint: https://api.digipag.app/c1/cashout/


{
    "api-key": "81bb141a-1746-49a8-basdasdas4a-c3b8dasdasdasaa0d2259",
    "name": "adm",
    "cpf": "7029166923232492",
    "keypix": "7029132323669492",
    "amount": 410.95
}

Chamada do callback

Para confirmar o pagamento, fazemos uma requisição HTTP POST para o endpoint cadastrado na requisição:

Exemplo de Chamada (POST)

será enviado:


{
  "amount": 0,
  "idTransaction": "52f129b8-4bfb-4acb-8c40-d3241182c0cf",
  "paymentMethod": "PIX",
  "status": "paid"
}