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

Gerar token de acesso

post https://api.pix.voluti.com.br/oauth/token

Use esse endpoint para gerar um token de acesso.

Scopes

Tabela com niveis de acesso pelo campo scope

Recursos	Leitura do escopo	Escrita escopo	Utilização acessível
Pix	pix.read	pix.write	Token de empresa
Webhooks	webhook.read	webhook.write	Token de empresa
Transações	transactions.read		Token de empresa
Conta	account.read		Token de empresa

Observações:

O token expira em 300 segundos.

Para conseguir gerar o token é necessário importar os certificados.

O campo scopes é opcional. Quando solicitado, define o nível de acesso que um token terá aos recursos da plataforma Voluti.

URL Expired

The URL for this request expired after 30 days.

Body Params

client_id

string

required

Código de identificação do cliente.

client_secret

string

required

Código para validar a identidade do cliente durante as solicitações do token de acesso.

grant_type

string

required

Tipo de concessão solicitada durante o processo de obtenção de tokens de acesso. Ele indica o método pelo qual o cliente obtém a autorização para acessar recursos protegidos.

scope

string

Quando solicitado, define o nível de acesso que um token terá aos recursos da plataforma Voluti.

Responses

Response body

object

access_token

string

Token de acesso emitido.

expires_in

int32

O número de segundos até à expiração do token desde a sua emissão.

refresh_expires_in

int32

Tempo para gerar novo token.

not-before-policy

int32

Define um tempo antes do qual o token não deve ser aceito. Essencialmente, é um timestamp que especifica a partir de quando o token se torna válido. Antes desse momento específico, qualquer tentativa de uso do token deve ser rejeitada.

token_type

string

Defaults to Bearer

Tipo de token.

scope

string

Escopo para utilização do token.

Response body

object

tokenType

string

Tipo de token.

expiresAt

integer

O número de segundos até à expiração do token desde a sua emissão.

refreshExpiresIn

integer

Tempo para gerar novo token.

notBeforePolicy

integer

accessToken

string

Token de acesso emitido.

scope

string

Escopo para utilização do token.

Response body

object

type

string

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

title

string

Descrição resumida do problema.

status

string

Defaults to 400

Código HTTP do status retornado.

detail

string

Descrição detalhada do problema.

Response body

object

type

string

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

title

string

Descrição resumida do problema.

status

string

Defaults to 401

Código HTTP do status retornado.

detail

string

Descrição detalhada do problema.

Response body

object

type

string

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

title

string

Descrição resumida do problema.

status

string

Defaults to 500

Código HTTP do status retornado.

detail

string

Descrição detalhada do problema.

Updated 9 months ago

📖Cash in - Pix

Payload de uma cobrança

Did this page help you?

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.pix.voluti.com.br/oauth/token \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
 
1
{
2
  "access_token": "string",
3
  "expires_in": -2147483648,
4
  "refresh_expires_in": -2147483648,
5
  "not-before-policy": 1622476800,
6
  "token_type": "Bearer",
7
  "scope": "string"
8
}

Updated 9 months ago

📖Cash in - Pix

Payload de uma cobrança

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

201Created

202Accepted

400Bad Request

401Unauthorized

500Internal Server Error