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

Criar webhooks para operações de transferência

post https://accounts.voluti.com.br/api/v2/webhooks/transfer

Use esse endpoint pra criar webhooks que serão acionados quando a operação de levantamento tiver sido liquidada ou cancelada.

URL Expired

The URL for this request expired after 30 days.

Body Params

uri

required

Identificador de recurso uniforme (URI) que aponta para o recurso específico.

string

E-mail utilizado para realizar as notificações de erros de envio de webhooks

method

string

Defaults to POST

Especifica o método HTTP que deve ser usado para enviar o webhook.

enabled

boolean

required

Defaults to true

Um valor booleano que indica se o recurso ou item está habilitado (true) ou desabilitado (false).

pauseOnFail

boolean

Defaults to true

headers

object

Este campo especifica os cabeçalhos HTTP que podem ser enviados junto com o webhook. É um objeto que contém pares de chave-valor, onde cada chave representa o nome do cabeçalho e o valor associado é o conteúdo desse cabeçalho.

Responses

Response body

object

uuid

Identificador único para cada item no conjunto de dados.

type

string

O tipo de transação ou evento.

TRANSFER RECEIVE REFUND CASHOUT REJECT

uri

Identificador de recurso uniforme (URI) que aponta para o recurso específico.

enabled

boolean

m valor booleano que indica se o recurso ou item está habilitado (true) ou desabilitado (false).

Response body

object

type

string

title

string

detail

string

instance

string

Response body

object

type

string

title

string

detail

string

instance

string

Response body

object

type

string

title

string

detail

string

instance

string

Response body

object

type

string

title

string

detail

string

instance

string

Response body

object

type

string

title

string

detail

string

instance

string

Response body

object

type

string

title

string

detail

string

instance

string

503

Service unavailable

504

Gateway timeout

Callback

Updated 3 months ago

Remove um webhook

Criar webhooks para receber operações

Did this page help you?

Language

Credentials

OAuth2

Bearer

URL


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://accounts.voluti.com.br/api/v2/webhooks/transfer \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "method": "POST",
8
  "enabled": true,
9
  "pauseOnFail": true
10
}
11
'


xxxxxxxxxx
 
1
{
2
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3
  "type": "TRANSFER",
4
  "uri": "string",
5
  "enabled": true
6
}

Updated 3 months ago

Remove um webhook

Criar webhooks para receber operações

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

400Bad request

401Unauthorized

403Access denied

409Conflict

429Rate limit exceeded

500Internal server error