VolgaPay API

Documentação da API

Informações Gerais

URL Base: https://app.volgapay.com
Autenticação: Defina o token no header Authorization (encontrado nas configurações).

Criar Transação

Endpoint para criar uma solicitação de pagamentos.

POST /api/create
Headers:
  • Content-Type: application/json
  • Authorization: Bearer <token>
POST DATA:
  • method: pix, nequi, clabe
  • amount: valor em inteiro ou decimal

Exemplo PIX


curl -X POST "https://app.volgapay.com/api/create" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer TOKEN" \
-d '{
    "method": "pix",
    "amount": 15,
    "payerName": "Ramiro Ngando",
    "payerCPF": "123.456.789-10"
}'
Exemplo de resposta PIX (200):
{ "data": { "amount": 15.0, "createTime": 1759021975521, "id": "ORD1759021972TW0Y97", "qrcode": "00020101021226940014br.gov.bcb.pix2572qrcode.783d67e4b7135204000053039865802BR5913LEOPARDO LTDA6009Sao Paulo62070503***6304A9CC", "status": "PENDING", "url": "https://pro.h5.com/payment/brl/5320e4ebd91342aab1ea4f2ccc5e007a?amount=15¤cy=BRL&method=PIX&qrcode=00020101021226940014br.gov.bcb.pix2572qrcode.hyperwalletip.com.br%2Fdynamic%2F54a57d81-fc4c-47f6-9801-783d67e4b7135204000053039865802BR5913LEOPARDO+LTDA6009Sao+Paulo62070503%2A%2A%2A6304A9CC" }, "error": null }

Exemplo NEQUI


curl -X POST 'https://app.volgapay.com/api/create' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TOKEN' \
-d '{
    "method": "nequi",
    "amount": 10000,
    "bankName": "BANCAMIA S.A.",
    "accountNo": "1234567890",
    "payerName": "Ramiro Ngando",
    "phoneNumber": "3043219876",
    "payerEmail": "[email protected]",
    "docNumber": "1234567890",
    "docType": "CC",
    "accountWallet": "1234567890"
}'
Exemplo de resposta NEQUI (200):
{ "amount": 10000.0, "createTime": 1759023225566, "error": null, "id": "ORD175902322256507C", "url": "https://app.refacil.co/refacilpay/payLink/108/2ce14720-9c0b-11f0-9553-7f31e3b01e03" }

Exemplo CLABE


curl --location 'https://app.volgapay.com/api/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data '{
    "method": "clabe",
    "amount": 1000
}'
Exemplo de resposta CLABE (200):
{ "data": { "amount": 1000.0, "clabe": "646546517999122837", "createTime": 1759023408328, "id": "ORD175902340484Q3HV", "status": 1759023408328, "url": "https://pro.h5.com/payment/mxn/7e6a092cca71424d9bc1d03b10f4019d?amount=1000¤cy=MXN&method=CLABE" }, "error": null }

Withdraw

Endpoint para criar uma solicitação de saque.

POST /api/withdraw
Headers:
  • Content-Type: application/json
  • Authorization: Bearer <token>
POST DATA:
  • method: pix, nequi, clabe
  • amount: valor em inteiro ou decimal

Exemplo PIX


curl --location 'https://app.volgapay.com/api/withdraw' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data-raw '{
    "method": "pix",
    "amount": 16.5,
    "name": "Ramiro Ngando",
    "account_type": "checking",
    "pix_key": "[email protected]",
    "bank_name": "COOPERATIVA DE CREDITO DO PLANALTO SUL - SICOOB CREDISSERRANA"
}'
Exemplo de resposta PIX (200):
{ "data": { "amount_requested": 16.5, "amount_sent": 16.33, "fee": 0.17, "id": "ORD1758973922XVJTPH", "method": "pix", "status": "PENDING" }, "error": null }

Exemplo NEQUI


curl --location 'https://app.volgapay.com/api/withdraw' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data-raw '{
    "method": "nequi",
    "amount": 2000,
    "bankName": "A continuação seleccione su banco",
    "accountNo": "123456789012",
    "customerName": "Ramiro Ngando",
    "customerPhone": "3678295992",
    "customerEmail": "[email protected]",
    "documentNumber": "1234567890",
    "documentType": "CC"
}'
Exemplo de resposta NEQUI (200):
{ "data": { "amount_requested": 2000, "amount_sent": 1980, "fee": 20.0, "id": "ORD1758989644IKTUO7", "method": "nequi", "status": "PENDING" }, "error": null }

Exemplo CLABE


curl --location 'https://app.volgapay.com/api/withdraw' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data '{
    "method": "clabe",
    "amount": 200,
    "bankName": "BANCOMEXT",
    "bankCode": "37006",
    "accountNo": "123456789012",
    "customerName": "Ramiro Ngando",
    "accountType": "40"
}'
Exemplo de resposta CLABE (200):
{ "data": { "amount_requested": 200, "amount_sent": 198, "fee": 2.0, "id": "ORD1759024063NUE4O7", "method": "nequi", "status": "PENDING" }, "error": null }

Consultar Transações

Endpoint para consultar todas as transações.

GET /api/transactions
Headers:
  • Authorization: Bearer <JWT_TOKEN>

Usando a API com Python


from requests import Session

net = Session()
net.headers['Authorization'] = 'Bearer JWT_TOKEN'

r = net.get('https://app.volgapay.com/api/transactions')
print(r.json())
Resposta:
{"data": {"historics": [...], "next": false, "prev": false}, "error": null}

Exemplo JavaScript (Axios)

axios.get('https://app.volgapay.com/api/transactions', {
    headers: {
        'Authorization': 'Bearer JWT_TOKEN'
    }
})
.then(response => {
    console.log(response.data);
})
.catch(error => {
    console.error(error);
});

Consultar Status da Transação

Endpoint para consultar o status de uma transação específica.

GET /api/transactions/{id}
Headers:
  • Authorization: Bearer <JWT_TOKEN>
Parâmetros da URL:
  • id: ID da transação

Exemplo Python

from requests import Session

net = Session()
net.headers['Authorization'] = 'Bearer JWT_TOKEN'

r = net.get('https://app.volgapay.com/api/transactions/e205c0e666bc45fbb29d7a85d1f85cbf')
print(r.json())
Resposta:
{"data": [...], "error": null}

Exemplo JavaScript (Axios)

axios.get('https://app.volgapay.com/api/transactions/e205c0e666bc45fbb29d7a85d1f85cbf', {
    headers: {
        'Authorization': 'Bearer JWT_TOKEN'
    }
})
.then(response => {
    console.log(response.data);
})
.catch(error => {
    console.error(error);
});

Consultar Saques

Endpoint para consultar todos os saques.

GET /api/withdraws
Headers:
  • Authorization: Bearer <JWT_TOKEN>

Exemplo Python

from requests import Session

net = Session()
net.headers['Authorization'] = 'Bearer JWT_TOKEN'

r = net.get('https://app.volgapay.com/api/withdraws')
print(r.json())
Resposta:
{"data": {"withdraws": [...], "next": false, "prev": false}, "error": null}

Exemplo JavaScript (Axios)

axios.get('https://app.volgapay.com/api/withdraws', {
    headers: {
        'Authorization': 'Bearer JWT_TOKEN'
    }
})
.then(response => {
    console.log(response.data);
})
.catch(error => {
    console.error(error);
});

Informações do Token

Endpoint para obter informações sobre o token de autenticação.

GET /api/info
Headers:
  • Authorization: Bearer <JWT_TOKEN>

Exemplo Python

from requests import Session

net = Session()
net.headers['Authorization'] = 'Bearer JWT_TOKEN'

r = net.get('https://app.volgapay.com/api/info')
print(r.json())
Resposta:
{"data": {"nome": "Eduardo James", "email": "[email protected]", ...}, "error": null}

Exemplo JavaScript (Axios)

axios.get('https://app.volgapay.com/api/info', {
    headers: {
        'Authorization': 'Bearer JWT_TOKEN'
    }
})
.then(response => {
    console.log(response.data);
})
.catch(error => {
    console.error(error);
});

Usando a API com JavaScript (Axios)

Exemplo adicional de como criar transações usando JavaScript e Axios.

Criar Transação

// Certifique-se de ter o Axios instalado ou incluir via CDN
axios.post('https://app.volgapay.com/api/create', {
    method: 'pix',
    amount: 11000
}, {
    headers: {
        'Authorization': 'Bearer JWT_TOKEN'
    }
})
.then(response => {
    console.log(response.data);
})
.catch(error => {
    console.error(error);
});