Bills & Payments
All bills endpoints require
Authorization: Bearer <token>.
POST /v1/bills/payBill
Pay a bill (boleto) using barcode.
Headers:
| Header | Value | Required |
|---|---|---|
x-client-id | Your tenant ID | Yes |
Idempotency-Key | UUID | Recommended |
Request Body:
json
{
"accountFrom": "30054029183",
"barCode": {
"type": "NPC",
"digitable": "23793.38128 60000.000003 00000.000400 1 84340000010000",
"barCode": "23791843400000100003381286000000000000000040"
},
"billData": {
"value": 100.00,
"originalValue": 100.00,
"valueWithDiscount": 95.00,
"valueWithAdditional": 102.00
},
"cpfcnpj": "11122233344",
"dueDate": "2026-03-20",
"externalNSU": "123456",
"externalTerminal": "TERM001"
}| Field | Type | Required | Description |
|---|---|---|---|
accountFrom | string | Yes | Debiting account number |
barCode.type | string | Yes | Barcode type |
barCode.digitable | string | Yes | Digitable line |
barCode.barCode | string | Yes | Barcode numeric value |
billData.value | number | Yes | Amount to pay |
billData.originalValue | number | Yes | Original bill value |
billData.valueWithDiscount | number | No | Value with discount |
billData.valueWithAdditional | number | No | Value with fees/interest |
cpfcnpj | string | Yes | Payer CPF/CNPJ |
dueDate | string | No | Due date (yyyy-MM-dd) |
Example:
bash
curl -X POST https://baas-gtw.axiadigitalsolutions.com/v1/bills/payBill \
-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 '{
"accountFrom": "30054029183",
"barCode": {
"type": "NPC",
"digitable": "23793.38128 60000.000003 00000.000400 1 84340000010000",
"barCode": "23791843400000100003381286000000000000000040"
},
"billData": {
"value": 100.00,
"originalValue": 100.00,
"valueWithDiscount": 0,
"valueWithAdditional": 0
},
"cpfcnpj": "11122233344"
}'POST /v1/bills/checkBill
Query bill details by barcode before paying.
Request Body: Barcode data (varies by bill type).
POST /v1/bills/CreateCharge
Create a billing charge (boleto).
Request Body: Dynamic fields depending on charge type.
POST /v1/bills/CheckCharge
Check the status of a charge.
Request Body:
json
{
"transactionId": "7110444"
}POST /v1/bills/getChargePDF
Get the PDF of a charge (boleto).
Request Body:
json
{
"transactionId": "7110444"
}Response: PDF binary or base64-encoded PDF data.