PIX
All PIX endpoints require
Authorization: Bearer <token>unless stated otherwise.
POST /v1/pix/create
Register a new PIX key for an account.
Request Body:
json
{
"key": "joao@email.com",
"keyType": "EMAIL",
"accountId": "30054029183",
"onBoardingId": "8f92c748-c37c-467d-ac69-6513706d7c60"
}| Field | Type | Required | Description |
|---|---|---|---|
key | string | Yes | PIX key value |
keyType | string | Yes | EVP, CPF, CNPJ, EMAIL, or PHONE |
accountId | string | Yes | Account number |
onBoardingId | string | Yes | Onboarding ID |
PIX Key Types:
| Type | Format | Example |
|---|---|---|
EVP | Random UUID (generated automatically) | — |
CPF | 11 digits | 48059890093 |
CNPJ | 14 digits | 37702652000188 |
EMAIL | Email address | joao@email.com |
PHONE | +55XXXXXXXXXXX | +5511999999999 |
Example:
bash
curl -X POST https://baas-gtw.axiadigitalsolutions.com/v1/pix/create \
-H "Authorization: Bearer eyJhbGci..." \
-H "Content-Type: application/json" \
-d '{
"key": "joao@email.com",
"keyType": "EMAIL",
"accountId": "30054029183",
"onBoardingId": "8f92c748-c37c-467d-ac69-6513706d7c60"
}'POST /v1/pix/exclude
Remove a PIX key.
Request Body:
json
{
"key": "joao@email.com",
"idAccount": "30054029183",
"onBoardingId": "8f92c748-c37c-467d-ac69-6513706d7c60"
}GET /v1/pix/getKeys
List all PIX keys registered for an account.
Query Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
accountId | string | Yes | Account number |
documentNumber | string | Yes | CPF or CNPJ |
Example:
bash
curl -X GET "https://baas-gtw.axiadigitalsolutions.com/v1/pix/getKeys?accountId=30054029183&documentNumber=48059890093" \
-H "Authorization: Bearer eyJhbGci..."Response 200 OK:
json
{
"status": "CONFIRMED",
"data": {
"keys": [
{
"key": "joao@email.com",
"keyType": "EMAIL",
"createdAt": "2026-01-15T10:00:00Z"
},
{
"key": "e1cc3f1d-0487-46e3-a717-0538a40c40f6",
"keyType": "EVP",
"createdAt": "2026-01-10T08:30:00Z"
}
]
}
}POST /v1/pix/getAccountInfoByPixKey
Look up account holder information by their PIX key (DICT query).
Request Body:
json
{
"key": "joao@email.com",
"payerId": "08023293060",
"idAccount": "30054029183",
"onBoardingId": "8f92c748-c37c-467d-ac69-6513706d7c60",
"type": "EMAIL"
}| Field | Type | Required | Description |
|---|---|---|---|
key | string | Yes | PIX key to look up |
payerId | string | Yes | Payer's CPF/CNPJ |
idAccount | string | Yes | Payer's account ID |
onBoardingId | string | Yes | Payer's onboarding ID |
type | string | No | Key type hint |
POST /v1/pix/transfer
Execute a PIX transfer.
Headers:
| Header | Value | Required |
|---|---|---|
x-client-id | Your tenant ID | Yes |
Idempotency-Key | UUID | Recommended |
Request Body:
json
{
"amount": 150.00,
"debitParty": {
"taxId": "07693440704",
"name": "Davi Ferreira de Souza",
"branch": "20",
"account": "42161",
"accountType": "CACC"
},
"creditParty": {
"bank": "30306294",
"taxId": "07693440704",
"name": "Davi Ferreira de Souza",
"key": "testepix@celcoin.com.br",
"branch": "20",
"account": "42161",
"accountType": "CACC"
},
"initiationType": "DICT",
"remittanceInformation": "Pagamento de serviço",
"paymentType": "IMMEDIATE",
"urgency": "HIGH",
"transactionType": "TRANSFER",
"userId": "cfd11a01-293d-4573-9d28-2d7261d79aaf",
"onBoardingId": "8f92c748-c37c-467d-ac69-6513706d7c60"
}| Field | Type | Required | Description |
|---|---|---|---|
amount | number | Yes | Transfer amount in BRL |
debitParty.taxId | string | Yes | Payer CPF/CNPJ |
debitParty.name | string | Yes | Payer name |
debitParty.branch | string | Yes | Payer branch code |
debitParty.account | string | Yes | Payer account number |
debitParty.accountType | string | Yes | CACC (checking) or SVGS (savings) |
creditParty.bank | string | Yes | Recipient bank ISPB |
creditParty.taxId | string | Yes | Recipient CPF/CNPJ |
creditParty.name | string | Yes | Recipient name |
creditParty.key | string | No | Recipient PIX key |
creditParty.branch | string | Yes | Recipient branch code |
creditParty.account | string | Yes | Recipient account number |
creditParty.accountType | string | Yes | CACC or SVGS |
initiationType | string | Yes | DICT (key) or MANUAL |
remittanceInformation | string | No | Transfer description (max 140 chars) |
paymentType | string | Yes | IMMEDIATE |
urgency | string | Yes | HIGH or NORMAL |
transactionType | string | Yes | TRANSFER |
userId | string | Yes | Internal user ID |
onBoardingId | string | Yes | Onboarding ID |
Example:
bash
curl -X POST https://baas-gtw.axiadigitalsolutions.com/v1/pix/transfer \
-H "Authorization: Bearer eyJhbGci..." \
-H "Content-Type: application/json" \
-H "x-client-id: your-client-id" \
-H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
-d '{
"amount": 150.00,
"debitParty": {
"taxId": "07693440704",
"name": "Davi Ferreira de Souza",
"branch": "20",
"account": "42161",
"accountType": "CACC"
},
"creditParty": {
"bank": "30306294",
"taxId": "07693440704",
"name": "Davi Ferreira de Souza",
"key": "testepix@celcoin.com.br",
"branch": "20",
"account": "42161",
"accountType": "CACC"
},
"initiationType": "DICT",
"remittanceInformation": "Pagamento de serviço",
"paymentType": "IMMEDIATE",
"urgency": "HIGH",
"transactionType": "TRANSFER",
"userId": "cfd11a01-293d-4573-9d28-2d7261d79aaf",
"onBoardingId": "8f92c748-c37c-467d-ac69-6513706d7c60"
}'Response 200 OK:
json
{
"status": "CONFIRMED",
"data": {
"transactionId": "E384040820262603101234567890",
"endToEndId": "E384040820262603101234567890",
"status": "CONFIRMED"
}
}Antifraud: This endpoint may return
202 Acceptedif the transaction requires manual approval. See Antifraud & Approval Flow.
GET /v1/pix/check
Check the status of a PIX transaction.
Query Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
codigo | string | Yes | Transaction code / endToEndId |
Example:
bash
curl -X GET "https://baas-gtw.axiadigitalsolutions.com/v1/pix/check?codigo=E384040820262603101234567890" \
-H "Authorization: Bearer eyJhbGci..."POST /v1/pix/createStaticQRCode
Create a static PIX QR Code for receiving payments.
Request Body:
json
{
"key": "joao@email.com",
"accountId": "30054029183",
"amount": 50.00,
"transactionIdentification": "pedido-12345",
"additionalInformation": "Pagamento ref. pedido #12345",
"documentNumber": "48059890093"
}| Field | Type | Required | Description |
|---|---|---|---|
key | string | Yes | PIX key |
accountId | string | Yes | Account number |
amount | number | No | Fixed amount (omit for open amount) |
transactionIdentification | string | No | Custom identifier (max 25 chars) |
additionalInformation | string | No | Additional info displayed to payer |
documentNumber | string | Yes | Account holder CPF/CNPJ |
Example:
bash
curl -X POST https://baas-gtw.axiadigitalsolutions.com/v1/pix/createStaticQRCode \
-H "Authorization: Bearer eyJhbGci..." \
-H "Content-Type: application/json" \
-d '{
"key": "joao@email.com",
"accountId": "30054029183",
"amount": 50.00,
"transactionIdentification": "pedido-12345",
"additionalInformation": "Pagamento ref. pedido #12345",
"documentNumber": "48059890093"
}'Response 200 OK:
json
{
"status": "CONFIRMED",
"data": {
"transactionId": "QR-2026031700001",
"emv": "00020126580014br.gov.bcb.pix0136e1cc3f1d-0487-46e3-a717-0538a40c40f6520400005303986540550.005802BR5912JOAO DA SILVA6015Sao Paulo62070503***6304A1D8",
"qrCodeBase64": "data:image/png;base64,iVBORw0KGgo..."
}
}GET /v1/pix/getStaticQRCode
Retrieve a previously created static QR Code.
Note: This endpoint does NOT require authentication.
Query Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
transactionId | string | Yes | QR Code transaction ID |
userId | string | Yes | User who created the QR Code |
POST /v1/pix/getQRCodeDataByEmv
Parse a PIX QR Code EMV string to extract payment information.
Request Body:
json
{
"emv": "00020126580014br.gov.bcb.pix0136e1cc3f1d-0487-46e3-a717-0538a40c40f6520400005303986540515.005802BR5912AXIA BANKING6015Sao Jose dos Ca61081224039062070503***6304A1D8",
"payerId": "07693440704",
"idAccount": "30054029183"
}| Field | Type | Required | Description |
|---|---|---|---|
emv | string | Yes | QR Code EMV payload string |
payerId | string | Yes | Payer's CPF/CNPJ |
idAccount | string | Yes | Payer's account number |
POST /v1/pix/pixPayByQRCode
Execute a PIX payment using a QR Code EMV.
Headers:
| Header | Value | Required |
|---|---|---|
x-client-id | Your tenant ID | Yes |
Idempotency-Key | UUID | Recommended |
Request Body:
json
{
"emv": "00020126580014br.gov.bcb.pix...",
"payerId": "07693440704",
"idAccount": "30054029183",
"userId": "cfd11a01-293d-4573-9d28-2d7261d79aaf",
"amount": 50.00
}| Field | Type | Required | Description |
|---|---|---|---|
emv | string | Yes | QR Code EMV payload |
payerId | string | Yes | Payer's CPF/CNPJ |
idAccount | string | Yes | Payer's account number |
userId | string | Yes | Internal user ID |
amount | number | Yes | Payment amount (BRL) |
POST /v1/pix/reverse
Request a PIX reversal (refund).
Request Body:
json
{
"transactionId": "E384040820262603101234567890",
"endToEndId": "E384040820262603101234567890",
"amount": 10.50,
"reason": "FRAUD",
"reversalDescription": "Estorno PIX - pagamento duplicado",
"documentNumber": "48059890093"
}| Field | Type | Required | Description |
|---|---|---|---|
transactionId | string | Yes | Original transaction ID |
endToEndId | string | Yes | End-to-end ID of original PIX |
amount | number | Yes | Reversal amount (BRL) |
reason | string | Yes | FRAUD, OPERATIONAL_FLAW, or REFUND |
reversalDescription | string | No | Human-readable reason |
documentNumber | string | No | Account holder CPF/CNPJ |
Example:
bash
curl -X POST https://baas-gtw.axiadigitalsolutions.com/v1/pix/reverse \
-H "Authorization: Bearer eyJhbGci..." \
-H "Content-Type: application/json" \
-d '{
"transactionId": "E384040820262603101234567890",
"endToEndId": "E384040820262603101234567890",
"amount": 10.50,
"reason": "REFUND",
"reversalDescription": "Estorno PIX - pagamento duplicado",
"documentNumber": "48059890093"
}'