Home

Welcome to the Voluti documentation
Authentication and security
- Certificates
About our APIs
Webhooks
- Configuration and operation of Webhooks🚧
- Response Payload Scenarios for Webhooks 🚧

Pix - Cash In

📖Cash in - Pix
Autenticação
- Gerar token de acessopost
Payload de uma cobrança
- Obter payload JSON da cobrança imediataget
- Obter payload JSON para cobrança com vencimentoget
Cobranças para pagamento imediato
Cobranças com vencimento
Cobranças com vencimento em lote
Configuração de localização para payloads
Gerenciamento de PIX
Webhook

Voluti - Cash out

📖Cash Out - Pix
Authentication
- Get an access token.post
Accounts
Payments
Infractions
Webhooks

Home

Welcome to the Voluti documentation
Authentication and security
- Certificates
About our APIs
Webhooks
- Configuration and operation of Webhooks🚧
- Response Payload Scenarios for Webhooks 🚧

Pix - Cash In

📖Cash in - Pix
Autenticação
- Gerar token de acessopost
Payload de uma cobrança
- Obter payload JSON da cobrança imediataget
- Obter payload JSON para cobrança com vencimentoget
Cobranças para pagamento imediato
Cobranças com vencimento
Cobranças com vencimento em lote
Configuração de localização para payloads
Gerenciamento de PIX
Webhook

Voluti - Cash out

📖Cash Out - Pix
Authentication
- Get an access token.post
Accounts
Payments
Infractions
Webhooks

Consultar lotes de cobranças com vencimento

get https://api.pix.voluti.com.br/lotecobv

Use este endpoint para consultar lista de lotes de cobranças com vencimento.

URL Expired

The URL for this request expired after 30 days.

Query Params

inicio

date-time

required

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

fim

date-time

required

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

paginacao.paginaAtual

int32

≥ 0

Defaults to 0

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

paginacao.itensPorPagina

int32

1 to 1000

Defaults to 100

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Responses

Response body

object

parametros

object

required

Parâmetros utilizados para a realização de uma consulta de lote de cobranças com vencimento.

inicio

date-time

required

Data inicial utilizada na consulta. Respeita RFC 3339.

fim

date-time

required

Data de fim utilizada na consulta. Respeita RFC 3339.

paginacao

object

required

lotes

array of objects

required

Lotes de solicitações de criação/alteração de cobranças com vencimento*

object

int64

required

descricao

string

required

criacao

date-time

required

Timestamp que indica o momento em que foi criado o lote. Respeita o formato definido na RFC 3339.

cobsv

array of objects

required

cobsv*

object

txid

string

required

Identificador da transação (txid):

O campo txid determina o identificador da transação, sendo crucial para o processo de conciliação de pagamentos, pois determina a transação de forma única. Na pacs.008, é mencionado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Funcionalidade:

O txid é gerado pelo usuário recebedor e enviado ao PSP do pagador.
Após a confirmação do pagamento, é transmitido para o SPI via pacs.008 e também para o PSP do recebedor.
Ao detectar um pagamento com txid, o PSP do recebedor pode informar ao usuário recebedor sobre a liquidação específica desse pagamento.

Responsabilidades:

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade.
Cada txid é único por CPF/CNPJ do usuário recebedor, com a validação dessa regra realizada pelo PSP recebedor na API Pix.

status

string

required

EM_PROCESSAMENTO CRIADA NEGADA

problema

object

criacao

date-time

Data e hora em que a cobrança foi criada. Respeita RFC 3339.

Response body

object

type

uri

required

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

title

string

required

Descrição resumida do problema.

status

integer

required

Código HTTP do status retornado.

detail

string

Descrição completa do problema.

correlationId

string

Identificador de correlação do problema para fins de suporte

violacoes

array of objects

violacoes

object

razao

string

Descrição do erro

propriedade

string

Nome da propriedade

valor

string

Valor da propriedade

Response body

object

type

uri

required

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

title

string

required

Descrição resumida do problema.

status

integer

required

Código HTTP do status retornado.

detail

string

Descrição completa do problema.

correlationId

string

Identificador de correlação do problema para fins de suporte

violacoes

array of objects

violacoes

object

razao

string

Descrição do erro

propriedade

string

Nome da propriedade

valor

string

Valor da propriedade

Updated 9 months ago

Consultar um lote específico de cobranças com vencimento

Configuração de localização para payloads

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.pix.voluti.com.br/lotecobv?paginacao.paginaAtual=0&paginacao.itensPorPagina=100' \
3
     --header 'accept: application/json'


xxxxxxxxxx
65
}
1
{
2
  "parametros": {
3
    "inicio": "2020-01-01T00:00:00Z",
4
    "fim": "2020-12-01T23:59:59Z",
5
    "paginacao": {
6
      "paginaAtual": 0,
7
      "itensPorPagina": 100,
8
      "quantidadeDePaginas": 1,
9
      "quantidadeTotalDeItens": 2
10
    }
11
  },
12
  "lotes": [
13
    {
14
      "allOf": [
15
        {
16
          "descricao": "Cobranças dos alunos do turno vespertino",
17
          "criacao": "2020-11-01T20:15:00.358Z",
18
          "cobsv": [
19
            {
20
              "criacao": "2020-11-01T20:15:00.358Z",
21
              "txid": "fb2761260e554ad593c7226beb5cb650",
22
              "status": "CRIADA"
23
            },
24
            {
25
              "txid": "7978c0c97ea847e78e8849634473c1f1",

Updated 9 months ago

Consultar um lote específico de cobranças com vencimento

Configuração de localização para payloads

Did this page help you?

Home
Welcome to the Voluti documentation
Authentication and security
Certificates
About our APIs
Webhooks
Response Payload Scenarios for Webhooks 🚧
Configuration and operation of Webhooks🚧

Pix - Cash In
📖Cash in - Pix
Autenticação
Gerar token de acessopost
Payload de uma cobrança
Obter payload JSON para cobrança com vencimentoget
Obter payload JSON da cobrança imediataget
Cobranças para pagamento imediato
Consultar lista de cobranças imediatasget
Criar cobrança imediatapost
Consultar cobrança imediataget
Revisar cobrança imediatapatch
Criar cobrança imediataput
Cobranças com vencimento
Consultar lista de cobranças com vencimentoget
Consultar cobrança com vencimentoget
Revisar cobrança com vencimentopatch
Criar cobrança com vencimentoput
Cobranças com vencimento em lote
Consultar lotes de cobranças com vencimentoget
Consultar um lote específico de cobranças com vencimentoget
Revisar cobranças específicas dentro de um lote de cobranças com vencimentopatch
Criar/Alterar lote de cobranças com vencimentoput
Configuração de localização para payloads
Desvincular uma cobrança de uma localizaçãodelete
Recuperar localização do payloadget
Consultar localização cadastradasget
Criar localização do payloadpost
Gerenciamento de PIX
Consultar devoluçãoget
Solicitar devoluçãoput
Consultar Pix recebidosget
Consultar Pixget
Webhook
Consultar webhooks cadastradosget
Cancelar webhook do Pixdelete
Informações acerca do webhook Pixget
Configurar webhook do Pixput

Voluti - Cash out
📖Cash Out - Pix
Authentication
Get an access token.post
Accounts
Get customer account balanceget
Get details of transactionget
Get customer account transactionsget
Payments
Get pix operation data by idempotencyKey.get
Get pix operation data by end-to-end id.get
Initiate a payment by Pix key.post
Initiate a payment using bank information.post
Initiate a payment by QR Code.post
Infractions
Create a defense against an infraction.post
Get infraction data by infraction ID.get
Returns infractions opened against the customer's account.get
Webhooks
Criar webhooks para operações de levantamentopost
Criar webhooks para operações de reembolsopost
Criar webhooks para receber operaçõespost
Criar webhooks para operações de transferênciapost
Remove um webhookdelete
Consulta um webhookget
Listar webhooksget

Home
Welcome to the Voluti documentation
Authentication and security
Certificates
About our APIs
Webhooks
Response Payload Scenarios for Webhooks 🚧
Configuration and operation of Webhooks🚧

Pix - Cash In
📖Cash in - Pix
Autenticação
Gerar token de acessopost
Payload de uma cobrança
Obter payload JSON para cobrança com vencimentoget
Obter payload JSON da cobrança imediataget
Cobranças para pagamento imediato
Consultar lista de cobranças imediatasget
Criar cobrança imediatapost
Consultar cobrança imediataget
Revisar cobrança imediatapatch
Criar cobrança imediataput
Cobranças com vencimento
Consultar lista de cobranças com vencimentoget
Consultar cobrança com vencimentoget
Revisar cobrança com vencimentopatch
Criar cobrança com vencimentoput
Cobranças com vencimento em lote
Consultar lotes de cobranças com vencimentoget
Consultar um lote específico de cobranças com vencimentoget
Revisar cobranças específicas dentro de um lote de cobranças com vencimentopatch
Criar/Alterar lote de cobranças com vencimentoput
Configuração de localização para payloads
Desvincular uma cobrança de uma localizaçãodelete
Recuperar localização do payloadget
Consultar localização cadastradasget
Criar localização do payloadpost
Gerenciamento de PIX
Consultar devoluçãoget
Solicitar devoluçãoput
Consultar Pix recebidosget
Consultar Pixget
Webhook
Consultar webhooks cadastradosget
Cancelar webhook do Pixdelete
Informações acerca do webhook Pixget
Configurar webhook do Pixput

Voluti - Cash out
📖Cash Out - Pix
Authentication
Get an access token.post
Accounts
Get customer account balanceget
Get details of transactionget
Get customer account transactionsget
Payments
Get pix operation data by idempotencyKey.get
Get pix operation data by end-to-end id.get
Initiate a payment by Pix key.post
Initiate a payment using bank information.post
Initiate a payment by QR Code.post
Infractions
Create a defense against an infraction.post
Get infraction data by infraction ID.get
Returns infractions opened against the customer's account.get
Webhooks
Criar webhooks para operações de levantamentopost
Criar webhooks para operações de reembolsopost
Criar webhooks para receber operaçõespost
Criar webhooks para operações de transferênciapost
Remove um webhookdelete
Consulta um webhookget
Listar webhooksget

200Lotes de cobranças com vencimento.

403Requisição de participante autenticado que viola alguma regra de autorização.

503Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.