Skip to main content
POST
/
api
/
pix
/
cash-out
Realizar pagamento PIX (Cash-Out)
curl --request POST \
  --url https://api.avista.global/api/pix/cash-out \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": 15.5,
  "details": {
    "key": "12312312387",
    "keyType": "DOCUMENT",
    "name": "John Marvin",
    "document": "12312312387"
  },
  "externalId": "external-teste-001",
  "description": "Pagamento fornecedor XYZ"
}
'
{
  "transactionId": "456",
  "externalId": "external-teste-001",
  "status": "PENDING",
  "generateTime": "2024-01-15T10:30:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Enter JWT token

Body

application/json
​
value
number
required

Valor da transação em reais (até duas casas decimais)

Example:

15.5

​
details
object
required

Informações da chave PIX de destino

​
externalId
string
required

Identificador externo único para a transação

Example:

"external-teste-001"

​
description
string

Descrição opcional da transação

Example:

"Pagamento fornecedor XYZ"

Response

Pagamento PIX iniciado com sucesso

​
transactionId
string
required

Identificador interno da transação gerada

Example:

"456"

​
externalId
string
required

Identificador externo informado na requisição

Example:

"external-teste-001"

​
status
enum<string>
required

Status atual da transação

Available options:
PENDING,
CONFIRMED,
ERROR
Example:

"PENDING"

​
generateTime
string
required

Data/hora de geração da transação (ISO 8601)

Example:

"2024-01-15T10:30:00.000Z"