// Endpoint: GET BASE_URL/qrdinamico
// Parâmetros:
// - user: Seu usuário (CNPJ)
// - password: Sua senha (Token)
// - secretkey: Sua SecretKey
// - valor: 1.23,
// - minutos: 5,
// - mensagem: "Referente ao produto Camiseta Branca",
GET BASE_URL/qrdinamico?valor=1.23&minutos=5&mensagem=Referente ao produto Camiseta Branca&user=seu_usuario&password=sua_senha&secretkey=sua_secret_key
// 200 OK
{
"data": {
"qrcodeId": "2d2bf7b7-24fc-4431-9cb8-460ea14ee9e9",
"qrcode": "00020101021226990014br.gov.bcb.pix...",
"qrcodeBase64": "iVBOR..."
}
}
// 400 Bad Request.
{
"error": "Bad Request",
"message": "Invalid request parameters"
}
// 401 Unauthorized.
{
"error": "Unauthorized",
"message": "Authentication failed"
}
// 404 Authorization não informado ou inválido.
{
"error": "Not Found",
"message": "Authorization not found or invalid"
}
// 406 Not Acceptable.
{
"error": "Not Acceptable",
"message": "Request not acceptable"
}
// 412 Precondition Failed.
{
"error": "Precondition Failed",
"message": "Required conditions are not met"
}
// 500 Internal Error.
{
"error": "Internal Server Error",
"message": "Something went wrong on the server"
}
// Endpoint: GET BASE_URL/qrstatus
// Parâmetros:
// - user: Seu usuário (CNPJ)
// - password: Sua senha (Token)
// - qrcodeId: UUID (Identificador único do QRCode)
GET BASE_URL/qrstatus?qrcodeId=2d2bf7b7-24fc-4431-9cb8-460ea14ee9e9&user=seu_usuario&password=sua_senha&secretkey=sua_secret_key
// 200 OK
{
"data": {
"status": "APPROVED",
"endToEndId": "E040131722...svm6Dgabyg",
"identificadorId": "QRS1TXRLPI...IOHQ0EHVWT",
"sender": {
"nome": "Owen Brasil Tecnologia",
"cpf_cnpj": "***.532.728-**",
"data": "2021-08-01T12:34:56.000Z",
"valor": 12.34
}
}
}
// 404 Authorization não informado ou inválido.
{
"error": "Not Found",
"message": "Authorization not found or invalid"
}
// 406 Not Acceptable.
{
"error": "Not Acceptable",
"message": "Request not acceptable"
}
// 412 Precondition Failed.
{
"error": "Precondition Failed",
"message": "Required conditions are not met"
}
// Endpoint: GET BASE_URL/qrrefund
// Parâmetros:
// - user: Seu usuário (CNPJ)
// - password: Sua senha (Token)
// - secretkey: Sua SecretKey
// - qrcodeId: Id do QRCode que deseja devolver ao pagador
BASE_URL/qrrefund?qrcodeId=2d2bf7b7-24fc-4431-9cb8-460ea14ee9e9&user=seu_usuario&password=sua_senha&secretkey=sua_secret_key
// 200 OK
{
"data": {
"refundId": "3324897f-393a-4bf6-b3af-0b999cbc2521"
}
}
// 400 Bad Request.
{
"error": "Bad Request",
"message": "Invalid request parameters"
}
// 401 Unauthorized.
{
"error": "Unauthorized",
"message": "Authorization failed"
}
// 404 Authorization não informado ou inválido.
{
"error": "Not Found",
"message": "Authorization not found or invalid"
}
// 412 Precondition Failed.
{
"error": "Precondition Failed",
"message": "Required conditions are not met"
}
// 500 Internal Error.
{
"error": "Internal Server Error",
"message": "Something went wrong on the server"
}
// Endpoint: GET BASE_URL/qrresumo
// Parâmetros:
// - user: Seu usuário (CNPJ)
// - password: Sua senha (Token)
// - inicio: Data de início no formato "ddmmaaaa"
// - fim: Data de término no formato "ddmmaaaa"
// - tipo: Tipo de Data do resumo (emissao, recebimento, vencimento)
BASE_URL/qrresumo?inicio=20220101&fim=20221231&tipo=emissao&user=seu_usuario&password=sua_senha
// 200 OK
{
"data": {
"resumo": [
{
"status": "APPROVED",
"transacaoId": "e411865e-cd8b-4b6f-ad1a-67016e6e27d3",
"transacaoTipo": "Pix Recebimento",
"mensagem": "...",
"endToEndId": "E040131722...svm6Dgabyg",
"identificadorId": "QRS1TXRLPI...IOHQ0EHVWT",
"sender": {
"nome": "Owen Brasil Tecnologia",
"cpf_cnpj": "***.532.728-**",
"data": "2021-08-01T12:34:56.000Z",
"valor": 120.34
}
}
]
}
}
// 406 Not Acceptable.
{
"error": "Not Acceptable",
"message": "Request not acceptable"
}
// 412 Precondition Failed.
{
"error": "Precondition Failed",
"message": "Required conditions are not met"
}
// Endpoint: GET BASE_URL/saldo
// Parâmetros:
// - user: Seu usuário (CNPJ)
// - password: Sua senha (Token)
BASE_URL/saldo?user=seu_usuario&password=sua_senha
// 200 OK
{
"data": {
"total": 12.34,
"disponivel": 11.34,
"bloqueado": 1
}
}
// 400 Bad Request.
{
"error": "Bad Request",
"message": "Invalid request parameters"
}
// 404 Authorization não informado ou inválido.
{
"error": "Not Found",
"message": "Authorization not found or invalid"
}
// 412 Precondition Failed.
{
"error": "Precondition Failed",
"message": "Required conditions are not met"
}
// 500 Internal Error.
{
"error": "Internal Server Error",
"message": "Something went wrong on the server"
}
// Endpoint: GET BASE_URL/retirada
// Parâmetros:
// - valor: Valor que deseja transferir (mínimo 0.01)
// - user: Seu usuário (CNPJ)
// - password: Sua senha (Token)
// - secretkey: Sua SecretKey
BASE_URL/retirada?valor=100.0&user=seu_usuario&password=sua_senha&secretkey=sua_secret_key
// 200 OK
{
"data": {
"transacaoId": "e411865e-cd8b-4b6f-ad1a-67016e6e27d3",
"endToEndId": "E231144472...KOYDkjOtrT",
"pspId": "04013172",
"pspNome": "CC SICOOB CRED-ACIF",
"agencia": "4321",
"conta": "20211831",
"contaNome": "JNP Software de Franca Ltda",
"contaTipo": "CC"
}
}
// 400 Bad Request.
{
"error": "Bad Request",
"message": "Invalid request parameters"
}
// 401 Unauthorized.
{
"error": "Unauthorized",
"message": "Invalid authentication credentials"
}
// 404 Authorization não informado ou inválido.
{
"error": "Not Found",
"message": "Authorization not found or invalid"
}
// 406 Not Acceptable.
{
"error": "Not Acceptable",
"message": "Request not acceptable"
}
// 412 Precondition Failed.
{
"error": "Precondition Failed",
"message": "Required conditions are not met"
}
// 500 Internal Error.
{
"error": "Internal Server Error",
"message": "Something went wrong on the server"
}
// Endpoint: GET BASE_URL/extrato
// Parâmetros:
// - inicio: Data de início no formato "ddmmaaaa"
// - fim: Data de término no formato "ddmmaaaa"
// - user: Seu usuário
// - password: Sua senha
BASE_URL/extrato?inicio=20220101&fim=20221231&user=seu_usuario&password=sua_senha
// 200 OK
{
"data": {
"extrato": [
{
"transacaoId": "e411865e-cd8b-4b6f-ad1a-67016e6e27d3",
"transacaoTipo": "PAYMENTINSTANTPAYMENT",
"descricao": "CREDITO DE PAGAMENTO VIA PIX",
"data": "2021-10-14T09:53:35.000Z",
"valor": 0.9,
"tipo": "C"
}
]
}
}
// 400 Bad Request.
{
"error": "Bad Request",
"message": "Invalid request parameters"
}
// 404 Authorization não informado ou inválido.
{
"error": "Not Found",
"message": "Authorization not found or invalid"
}
// 406 Not Acceptable.
{
"error": "Not Acceptable",
"message": "Request not acceptable"
}
// 412 Precondition Failed.
{
"error": "Precondition Failed",
"message": "Required conditions are not met"
}
// 500 Internal Error.
{
"error": "Internal Server Error",
"message": "Something went wrong on the server"
}