Skip to main content
POST
/
v1
/
transactions
Create Pix transaction
curl --request POST \
  --url http://localhost:4011/v1/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "12345678-1234-1234-1234-123456789012",
  "amount": 10,
  "description": "Internal transfer between accounts",
  "payee": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "bankAccountType": 0,
    "accountNumber": "123456",
    "accountDigit": "0",
    "key": "12345678901",
    "bankName": "Banco Example"
  },
  "priority": 1,
  "key": "recipient@example.com",
  "txId": "TXN-ABC-123"
}'
{
  "id": "TXN-abcd1234-5678-9012-3456-789012345678",
  "status": -1
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Body

application/json
​
accountId
string<uuid>
required

Payer account ID

Example:

"12345678-1234-1234-1234-123456789012"

​
amount
number
required

Transaction amount

Example:

10

​
description
string
required

Transaction description

Example:

"Internal transfer between accounts"

​
payee
object
required
​
priority
enum<integer>
required

Transaction priority enumeration (1- PRIMARY, 2- SECONDARY).

Available options:
1,
2
​
key
string
required

Pix key for the transaction

Example:

"recipient@example.com"

​
txId
string

Transaction identifier

Example:

"TXN-ABC-123"

Response

Transaction created successfully

​
id
string

Generated transaction ID

Example:

"TXN-abcd1234-5678-9012-3456-789012345678"

​
status
enum<integer>

Transaction status enumeration (-1 - PROCESSING_ERROR, 0- PROCESSING, 1- PENDING_CONFIRM, 2- EXECUTED, 3- FAILED, 4- REVERSAL, 5- REPROVED, 6- SCHEDULE, 7- CANCELLED).

Available options:
-1,
0,
1,
2,
3,
4,
5,
8,
9