Jeeves Public API (1.0.0)

Introduction

The Jeeves API is built around REST principles. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Authentication

The Jeeves API uses mTLS and OAuth 2.0 to authenticate requests. You can request your mTLS certificate and OAuth 2.0 credentials in both sandbox and production environments by reaching out to our support team.

All API requests will only work over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Errors

The Jeeves API uses standard HTTP response codes to indicate the success or failure of an API request. In general: codes in the 2XX range indicate success; codes in the 4XX range indicate an error in the information provided; codes in the 5XX range indicate an internal error with Jeeves application/server.

Currently, the Jeeves API has the following HTTP responses:

Code	Response	Description
200	Ok	Object was returned as expected.
201	Ok	Object was created as expected.
204	Ok	No return, but request was processed as expected.
400	Bad request	At least one argument is wrong or missing.
401	Unauthorized	No valid API token provided.
403	Forbidden	The API token doesn't have permission to perform the request.
404	Not found	The requested resource doesn't exist.
500	Server error	An internal error at Jeeves.

Download OpenAPI description

index.json

index.yaml

Servers

https://public-sandbox.tryjeeves.com/

https://public-api.jeev.es/

Boletos

The Boleto API supports the full boleto lifecycle, enabling clients to create, retrieve, extend, and cancel boletos via secure integration. It also supports Bolepix, which adds a Pix QR code to the boleto for instant settlement through Pix rails. For boletos paid via barcode or digitable line, the API provides an early payment notice before final settlement - offering visibility of the payment up to one day in advance, with guaranteed settlement. For boletos paid via Pix (via Bolepix), the boleto is marked as paid directly, as settlement is immediate.

Operations

List Boletos

Request

Retrieves a paginated list of boletos.

Query

pagenumber>= 1

The page number to retrieve.

Default 1

Example: page=1

pageSizenumber[ 1 .. 500 ]

Number of items per page.

Default 20

Example: pageSize=20

Headers

Accept-Languagestring

Language code for localization.

Default en-US

Enum"en-US""es-MX""pt-BR"

Example: en-US

const query = new URLSearchParams({
  page: '1',
  pageSize: '20'
}).toString();

const resp = await fetch(
  `https://public-sandbox.tryjeeves.com/v1/boletos?${query}`,
  {
    method: 'GET',
    headers: {
      'Accept-Language': 'en-US',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

List of boletos.

Bodyapplication/json

rowsArray of objects(BoletoDto)required

rows[].idstring= 36 charactersrequired

Unique boleto identification key in uuid v4 format.

Example: "4c2fa514-a44d-40f2-8d57-c0caf1b9165a"

rows[].boletoStatusstringnon-emptyrequired

Boleto status.

Enum"accepted""rejected""payment_notice""notary_office_payment_notice""registered""payment_blocked""paid""written_off"

Example: "registered"

rows[].amountnumbernon-empty> 0required

The boleto payment amount.

Example: 4000

rows[].dueDatestring or string= 10 charactersrequired

The due date (ISO 8601 format YYYY-MM-DD).

Example: "2024-07-12"

One of:

The due date (ISO 8601 format YYYY-MM-DD).

= 10 characters

string(date)= 10 characters

The due date (ISO 8601 format YYYY-MM-DD).

rows[].memostring[ 1 .. 320 ] charactersrequired

Optional note for the payer, shown on the boleto.

Example: "Payment for marketing services"

rows[].barcodestringnon-emptyrequired

The barcode for the boleto.

Example: "32994978900005000000001546128483498231955341"

rows[].digitableLinestringnon-emptyrequired

The digitable line for the boleto.

Example: "32990001524612848349582319553408497890000500002"

rows[].payerDataobject(PayerDataDto)required

rows[].payerData.namestring[ 1 .. 100 ] charactersrequired

The payer name.

Example: "Global Tech"

rows[].payerData.personTypestringnon-emptyrequired

The type of person.

Enum"natural""legal"

Example: "legal"

rows[].payerData.documentNumberstring[ 11 .. 14 ] charactersrequired

The payer document number (CPF for natural person - 11 digits, CNPJ for legal person - 14 digits).

Example: "12345678000195"

rows[].payerData.emailstring(email)[ 1 .. 320 ] charactersrequired

The payer email address

Example: "finance@globaltech.com"

rows[].payerData.phoneobject(PayerPhoneDto)required

rows[].payerData.phone.countryCodestring[ 1 .. 3 ] charactersrequired

The payer phone international dial code

Example: "055"

rows[].payerData.phone.areaCodestring[ 1 .. 2 ] charactersrequired

The payer phone area code

Example: "11"

rows[].payerData.phone.numberstring[ 1 .. 9 ] charactersrequired

The payer phone number

Example: "987654321"

rows[].payerData.addressobject(PayerAddressDto)required

rows[].payerData.address.streetstring[ 1 .. 500 ] charactersrequired

The payer address street name.

Example: "101 High St."

rows[].payerData.address.numberstring[ 1 .. 6 ] charactersrequired

The payer address number.

Example: "202"

rows[].payerData.address.complementstring<= 500 characters

The payer address complement.

Example: "Building A"

rows[].payerData.address.neighborhoodstring[ 1 .. 100 ] charactersrequired

The payer address neighborhood.

Example: "Tech Park"

rows[].payerData.address.postalCodestring= 8 charactersrequired

The payer address postal code (CEP).

Example: "01001000"

rows[].payerData.address.citystring[ 1 .. 100 ] charactersrequired

The payer address city.

Example: "São Paulo"

rows[].payerData.address.statestringnon-emptyrequired

The payer address state.

Enum"AC""AL""AM""AP""BA""CE""DF""ES""GO""MA"

Example: "SP"

rows[].qrCodeImagestring

QR code image in base64 format for BolePix payments.

Example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAY..."

rows[].bolepixEnabledboolean

If true, generates a BolePix boleto with a Pix QR code.

Default true

rows[].paymentDetailsobject(PaymentDetailsDto)

rows[].fineobject(FineDto)

Fine to be applied.

rows[].interestobject(InterestDto)

Interest to be applied.

rows[].metadataobject

Boleto metadata.

Example: {"key1":"value1"}

rows[].createdAtstring or stringnon-emptyrequired

Creation date (ISO 8601).

Example: "2024-06-23T09:15:32Z"

One of:

Creation date (ISO 8601).

non-empty

string(date)non-empty

Creation date (ISO 8601).

rows[].updatedAtstring or string

Updated at (ISO 8601).

Example: "2024-06-26T12:53:47Z"

One of:

Updated at (ISO 8601).

string(date)

Updated at (ISO 8601).

countnumberrequired

Example: 100

Response

application/json

{
  "rows": [
    { … }
  ],
  "count": 100
}

Create Boleto

Request

Creates a new boleto, available for immediate payment.

Headers

Accept-Languagestring

Language code for localization.

Default en-US

Enum"en-US""es-MX""pt-BR"

Example: en-US

Bodyapplication/jsonrequired

BoletoCreateDto

amountnumbernon-empty> 0required

Payment amount (positive)

Example: 5000

dueDatestring or string= 10 charactersrequired

Due date (ISO 8601 format: YYYY-MM-DD)

Example: "2025-01-15"

One of:

Due date (ISO 8601 format: YYYY-MM-DD)

= 10 characters

string(date)= 10 characters

Due date (ISO 8601 format: YYYY-MM-DD)

memostring[ 1 .. 100 ] charactersrequired

Description (max 100 chars)

Example: "Payment for services"

payerDataobject(PayerDataDto)required

payerData.namestring[ 1 .. 100 ] charactersrequired

The payer name.

Example: "Global Tech"

payerData.personTypestringnon-emptyrequired

The type of person.

Enum"natural""legal"

Example: "legal"

payerData.documentNumberstring[ 11 .. 14 ] charactersrequired

The payer document number (CPF for natural person - 11 digits, CNPJ for legal person - 14 digits).

Example: "12345678000195"

payerData.emailstring(email)[ 1 .. 320 ] charactersrequired

The payer email address

Example: "finance@globaltech.com"

payerData.phoneobject(PayerPhoneDto)required

payerData.phone.countryCodestring[ 1 .. 3 ] charactersrequired

The payer phone international dial code

Example: "055"

payerData.phone.areaCodestring[ 1 .. 2 ] charactersrequired

The payer phone area code

Example: "11"

payerData.phone.numberstring[ 1 .. 9 ] charactersrequired

The payer phone number

Example: "987654321"

payerData.addressobject(PayerAddressDto)required

payerData.address.streetstring[ 1 .. 500 ] charactersrequired

The payer address street name.

Example: "101 High St."

payerData.address.numberstring[ 1 .. 6 ] charactersrequired

The payer address number.

Example: "202"

payerData.address.complementstring<= 500 characters

The payer address complement.

Example: "Building A"

payerData.address.neighborhoodstring[ 1 .. 100 ] charactersrequired

The payer address neighborhood.

Example: "Tech Park"

payerData.address.postalCodestring= 8 charactersrequired

The payer address postal code (CEP).

Example: "01001000"

payerData.address.citystring[ 1 .. 100 ] charactersrequired

The payer address city.

Example: "São Paulo"

payerData.address.statestringnon-emptyrequired

The payer address state.

Enum"AC""AL""AM""AP""BA""CE""DF""ES""GO""MA"

Example: "SP"

metadataobject

Additional custom key-value pairs

Example: {"internalReference":"INV-789","key1":"value1","key2":"value2"}

bolepixEnabledboolean

If true, generates a BolePix boleto with a Pix QR code.

Default true

fineobject(FineDto)

Fine to be applied.

interestobject(InterestDto)

Interest to be applied.

const resp = await fetch(
  `https://public-sandbox.tryjeeves.com/v1/boletos`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Accept-Language': 'en-US',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      amount: 5000,
      dueDate: '2025-01-15',
      memo: 'Payment for services',
      payerData: {
        name: 'Global Tech',
        personType: 'legal',
        documentNumber: '12345678000195',
        email: 'finance@globaltech.com',
        phone: {
          countryCode: '055',
          areaCode: '11',
          number: '987654321'
        },
        address: {
          street: '101 High St.',
          number: '202',
          complement: 'Building A',
          neighborhood: 'Tech Park',
          postalCode: '01001000',
          city: 'São Paulo',
          state: 'SP'
        }
      },
      metadata: {
        internalReference: 'INV-789',
        key1: 'value1',
        key2: 'value2'
      },
      bolepixEnabled: true,
      fine: {
        type: 'absolute',
        amount: 100,
        percentage: 10,
        daysAfterDue: 10
      },
      interest: {
        type: 'calendar_days_daily_amount',
        dailyAmount: 100,
        monthlyPercentage: 10,
        daysAfterDue: 10
      }
    })
  }
);

const data = await resp.json();
console.log(data);

Responses

Creates a boleto and returns its details.

Bodyapplication/json

idstring= 36 charactersrequired

Unique boleto identification key in uuid v4 format.

Example: "4c2fa514-a44d-40f2-8d57-c0caf1b9165a"

boletoStatusstringnon-emptyrequired

Boleto status.

Enum"accepted""rejected""payment_notice""notary_office_payment_notice""registered""payment_blocked""paid""written_off"

Example: "registered"

amountnumbernon-empty> 0required

The boleto payment amount.

Example: 4000

dueDatestring or string= 10 charactersrequired

The due date (ISO 8601 format YYYY-MM-DD).

Example: "2024-07-12"

One of:

The due date (ISO 8601 format YYYY-MM-DD).

= 10 characters

string(date)= 10 characters

The due date (ISO 8601 format YYYY-MM-DD).

memostring[ 1 .. 320 ] charactersrequired

Optional note for the payer, shown on the boleto.

Example: "Payment for marketing services"

barcodestringnon-emptyrequired

The barcode for the boleto.

Example: "32994978900005000000001546128483498231955341"

digitableLinestringnon-emptyrequired

The digitable line for the boleto.

Example: "32990001524612848349582319553408497890000500002"

payerDataobject(PayerDataDto)required

payerData.namestring[ 1 .. 100 ] charactersrequired

The payer name.

Example: "Global Tech"

payerData.personTypestringnon-emptyrequired

The type of person.

Enum"natural""legal"

Example: "legal"

payerData.documentNumberstring[ 11 .. 14 ] charactersrequired

The payer document number (CPF for natural person - 11 digits, CNPJ for legal person - 14 digits).

Example: "12345678000195"

payerData.emailstring(email)[ 1 .. 320 ] charactersrequired

The payer email address

Example: "finance@globaltech.com"

payerData.phoneobject(PayerPhoneDto)required

payerData.phone.countryCodestring[ 1 .. 3 ] charactersrequired

The payer phone international dial code

Example: "055"

payerData.phone.areaCodestring[ 1 .. 2 ] charactersrequired

The payer phone area code

Example: "11"

payerData.phone.numberstring[ 1 .. 9 ] charactersrequired

The payer phone number

Example: "987654321"

payerData.addressobject(PayerAddressDto)required

payerData.address.streetstring[ 1 .. 500 ] charactersrequired

The payer address street name.

Example: "101 High St."

payerData.address.numberstring[ 1 .. 6 ] charactersrequired

The payer address number.

Example: "202"

payerData.address.complementstring<= 500 characters

The payer address complement.

Example: "Building A"

payerData.address.neighborhoodstring[ 1 .. 100 ] charactersrequired

The payer address neighborhood.

Example: "Tech Park"

payerData.address.postalCodestring= 8 charactersrequired

The payer address postal code (CEP).

Example: "01001000"

payerData.address.citystring[ 1 .. 100 ] charactersrequired

The payer address city.

Example: "São Paulo"

payerData.address.statestringnon-emptyrequired

The payer address state.

Enum"AC""AL""AM""AP""BA""CE""DF""ES""GO""MA"

Example: "SP"

qrCodeImagestring

QR code image in base64 format for BolePix payments.

Example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAY..."

bolepixEnabledboolean

If true, generates a BolePix boleto with a Pix QR code.

Default true

paymentDetailsobject(PaymentDetailsDto)

fineobject(FineDto)

Fine to be applied.

interestobject(InterestDto)

Interest to be applied.

metadataobject

Boleto metadata.

Example: {"key1":"value1"}

createdAtstring or stringnon-emptyrequired

Creation date (ISO 8601).

Example: "2024-06-23T09:15:32Z"

One of:

Creation date (ISO 8601).

non-empty

string(date)non-empty

Creation date (ISO 8601).

updatedAtstring or string

Updated at (ISO 8601).

Example: "2024-06-26T12:53:47Z"

One of:

Updated at (ISO 8601).

string(date)

Updated at (ISO 8601).

Response

application/json

{
  "id": "4c2fa514-a44d-40f2-8d57-c0caf1b9165a",
  "boletoStatus": "registered",
  "amount": 4000,
  "dueDate": "2024-07-12",
  "memo": "Payment for marketing services",
  "barcode": "32994978900005000000001546128483498231955341",
  "digitableLine": "32990001524612848349582319553408497890000500002",
  "payerData": {
    "name": "Global Tech",
    "personType": "legal",
    "documentNumber": "12345678000195",
    "email": "finance@globaltech.com",
    "phone": { … },
    "address": { … }
  },
  "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAY...",
  "bolepixEnabled": true,
  "paymentDetails": {
    "paidAmount": 5000,
    "method": "account_debit",
    "origin": "qr_code",
    "creditDate": "2025-01-15"
  },
  "fine": {
    "type": "absolute",
    "amount": 100,
    "percentage": 10,
    "daysAfterDue": 10
  },
  "interest": {
    "type": "calendar_days_daily_amount",
    "dailyAmount": 100,
    "monthlyPercentage": 10,
    "daysAfterDue": 10
  },
  "metadata": {
    "key1": "value1"
  },
  "createdAt": "2024-06-23T09:15:32Z",
  "updatedAt": "2024-06-26T12:53:47Z"
}

Get Boleto by ID

Request

Retrieves a specific boleto by its ID.

Path

idstring[^\/#\?]+?required

Boleto ID (UUID v4).

Headers

Accept-Languagestring

Language code for localization.

Default en-US

Enum"en-US""es-MX""pt-BR"

Example: en-US

const id = 'YOUR_id_PARAMETER';
const resp = await fetch(
  `https://public-sandbox.tryjeeves.com/v1/boletos/${id}`,
  {
    method: 'GET',
    headers: {
      'Accept-Language': 'en-US',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

Boleto details.

Bodyapplication/json

idstring= 36 charactersrequired

Unique boleto identification key in uuid v4 format.

Example: "4c2fa514-a44d-40f2-8d57-c0caf1b9165a"

boletoStatusstringnon-emptyrequired

Boleto status.

Enum"accepted""rejected""payment_notice""notary_office_payment_notice""registered""payment_blocked""paid""written_off"

Example: "registered"

amountnumbernon-empty> 0required

The boleto payment amount.

Example: 4000

dueDatestring or string= 10 charactersrequired

The due date (ISO 8601 format YYYY-MM-DD).

Example: "2024-07-12"

One of:

The due date (ISO 8601 format YYYY-MM-DD).

= 10 characters

string(date)= 10 characters

The due date (ISO 8601 format YYYY-MM-DD).

memostring[ 1 .. 320 ] charactersrequired

Optional note for the payer, shown on the boleto.

Example: "Payment for marketing services"

barcodestringnon-emptyrequired

The barcode for the boleto.

Example: "32994978900005000000001546128483498231955341"

digitableLinestringnon-emptyrequired

The digitable line for the boleto.

Example: "32990001524612848349582319553408497890000500002"

payerDataobject(PayerDataDto)required

payerData.namestring[ 1 .. 100 ] charactersrequired

The payer name.

Example: "Global Tech"

payerData.personTypestringnon-emptyrequired

The type of person.

Enum"natural""legal"

Example: "legal"

payerData.documentNumberstring[ 11 .. 14 ] charactersrequired

The payer document number (CPF for natural person - 11 digits, CNPJ for legal person - 14 digits).

Example: "12345678000195"

payerData.emailstring(email)[ 1 .. 320 ] charactersrequired

The payer email address

Example: "finance@globaltech.com"

payerData.phoneobject(PayerPhoneDto)required

payerData.phone.countryCodestring[ 1 .. 3 ] charactersrequired

The payer phone international dial code

Example: "055"

payerData.phone.areaCodestring[ 1 .. 2 ] charactersrequired

The payer phone area code

Example: "11"

payerData.phone.numberstring[ 1 .. 9 ] charactersrequired

The payer phone number

Example: "987654321"

payerData.addressobject(PayerAddressDto)required

payerData.address.streetstring[ 1 .. 500 ] charactersrequired

The payer address street name.

Example: "101 High St."

payerData.address.numberstring[ 1 .. 6 ] charactersrequired

The payer address number.

Example: "202"

payerData.address.complementstring<= 500 characters

The payer address complement.

Example: "Building A"

payerData.address.neighborhoodstring[ 1 .. 100 ] charactersrequired

The payer address neighborhood.

Example: "Tech Park"

payerData.address.postalCodestring= 8 charactersrequired

The payer address postal code (CEP).

Example: "01001000"

payerData.address.citystring[ 1 .. 100 ] charactersrequired

The payer address city.

Example: "São Paulo"

payerData.address.statestringnon-emptyrequired

The payer address state.

Enum"AC""AL""AM""AP""BA""CE""DF""ES""GO""MA"

Example: "SP"

qrCodeImagestring

QR code image in base64 format for BolePix payments.

Example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAY..."

bolepixEnabledboolean

If true, generates a BolePix boleto with a Pix QR code.

Default true

paymentDetailsobject(PaymentDetailsDto)

fineobject(FineDto)

Fine to be applied.

interestobject(InterestDto)

Interest to be applied.

metadataobject

Boleto metadata.

Example: {"key1":"value1"}

createdAtstring or stringnon-emptyrequired

Creation date (ISO 8601).

Example: "2024-06-23T09:15:32Z"

One of:

Creation date (ISO 8601).

non-empty

string(date)non-empty

Creation date (ISO 8601).

updatedAtstring or string

Updated at (ISO 8601).

Example: "2024-06-26T12:53:47Z"

One of:

Updated at (ISO 8601).

string(date)

Updated at (ISO 8601).

Response

application/json

{
  "id": "4c2fa514-a44d-40f2-8d57-c0caf1b9165a",
  "boletoStatus": "registered",
  "amount": 4000,
  "dueDate": "2024-07-12",
  "memo": "Payment for marketing services",
  "barcode": "32994978900005000000001546128483498231955341",
  "digitableLine": "32990001524612848349582319553408497890000500002",
  "payerData": {
    "name": "Global Tech",
    "personType": "legal",
    "documentNumber": "12345678000195",
    "email": "finance@globaltech.com",
    "phone": { … },
    "address": { … }
  },
  "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAY...",
  "bolepixEnabled": true,
  "paymentDetails": {
    "paidAmount": 5000,
    "method": "account_debit",
    "origin": "qr_code",
    "creditDate": "2025-01-15"
  },
  "fine": {
    "type": "absolute",
    "amount": 100,
    "percentage": 10,
    "daysAfterDue": 10
  },
  "interest": {
    "type": "calendar_days_daily_amount",
    "dailyAmount": 100,
    "monthlyPercentage": 10,
    "daysAfterDue": 10
  },
  "metadata": {
    "key1": "value1"
  },
  "createdAt": "2024-06-23T09:15:32Z",
  "updatedAt": "2024-06-26T12:53:47Z"
}

Cancel Boleto

Request

Cancels a registered boleto by its ID.

Path

idstring[^\/#\?]+?required

Boleto ID (UUID v4).

Headers

Accept-Languagestring

Language code for localization.

Default en-US

Enum"en-US""es-MX""pt-BR"

Example: en-US

const id = 'YOUR_id_PARAMETER';
const resp = await fetch(
  `https://public-sandbox.tryjeeves.com/v1/boletos/${id}/cancel`,
  {
    method: 'POST',
    headers: {
      'Accept-Language': 'en-US',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

Cancels a boleto and returns its details.

Bodyapplication/json

idstring= 36 charactersrequired

Unique boleto identification key in uuid v4 format.

Example: "4c2fa514-a44d-40f2-8d57-c0caf1b9165a"

boletoStatusstringnon-emptyrequired

Boleto status.

Enum"accepted""rejected""payment_notice""notary_office_payment_notice""registered""payment_blocked""paid""written_off"

Example: "registered"

amountnumbernon-empty> 0required

The boleto payment amount.

Example: 4000

dueDatestring or string= 10 charactersrequired

The due date (ISO 8601 format YYYY-MM-DD).

Example: "2024-07-12"

One of:

The due date (ISO 8601 format YYYY-MM-DD).

= 10 characters

string(date)= 10 characters

The due date (ISO 8601 format YYYY-MM-DD).

memostring[ 1 .. 320 ] charactersrequired

Optional note for the payer, shown on the boleto.

Example: "Payment for marketing services"

barcodestringnon-emptyrequired

The barcode for the boleto.

Example: "32994978900005000000001546128483498231955341"

digitableLinestringnon-emptyrequired

The digitable line for the boleto.

Example: "32990001524612848349582319553408497890000500002"

payerDataobject(PayerDataDto)required

payerData.namestring[ 1 .. 100 ] charactersrequired

The payer name.

Example: "Global Tech"

payerData.personTypestringnon-emptyrequired

The type of person.

Enum"natural""legal"

Example: "legal"

payerData.documentNumberstring[ 11 .. 14 ] charactersrequired

The payer document number (CPF for natural person - 11 digits, CNPJ for legal person - 14 digits).

Example: "12345678000195"

payerData.emailstring(email)[ 1 .. 320 ] charactersrequired

The payer email address

Example: "finance@globaltech.com"

payerData.phoneobject(PayerPhoneDto)required

payerData.phone.countryCodestring[ 1 .. 3 ] charactersrequired

The payer phone international dial code

Example: "055"

payerData.phone.areaCodestring[ 1 .. 2 ] charactersrequired

The payer phone area code

Example: "11"

payerData.phone.numberstring[ 1 .. 9 ] charactersrequired

The payer phone number

Example: "987654321"

payerData.addressobject(PayerAddressDto)required

payerData.address.streetstring[ 1 .. 500 ] charactersrequired

The payer address street name.

Example: "101 High St."

payerData.address.numberstring[ 1 .. 6 ] charactersrequired

The payer address number.

Example: "202"

payerData.address.complementstring<= 500 characters

The payer address complement.

Example: "Building A"

payerData.address.neighborhoodstring[ 1 .. 100 ] charactersrequired

The payer address neighborhood.

Example: "Tech Park"

payerData.address.postalCodestring= 8 charactersrequired

The payer address postal code (CEP).

Example: "01001000"

payerData.address.citystring[ 1 .. 100 ] charactersrequired

The payer address city.

Example: "São Paulo"

payerData.address.statestringnon-emptyrequired

The payer address state.

Enum"AC""AL""AM""AP""BA""CE""DF""ES""GO""MA"

Example: "SP"

qrCodeImagestring

QR code image in base64 format for BolePix payments.

Example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAY..."

bolepixEnabledboolean

If true, generates a BolePix boleto with a Pix QR code.

Default true

paymentDetailsobject(PaymentDetailsDto)

fineobject(FineDto)

Fine to be applied.

interestobject(InterestDto)

Interest to be applied.

metadataobject

Boleto metadata.

Example: {"key1":"value1"}

createdAtstring or stringnon-emptyrequired

Creation date (ISO 8601).

Example: "2024-06-23T09:15:32Z"

One of:

Creation date (ISO 8601).

non-empty

string(date)non-empty

Creation date (ISO 8601).

updatedAtstring or string

Updated at (ISO 8601).

Example: "2024-06-26T12:53:47Z"

One of:

Updated at (ISO 8601).

string(date)

Updated at (ISO 8601).

Response

application/json

{
  "id": "4c2fa514-a44d-40f2-8d57-c0caf1b9165a",
  "boletoStatus": "registered",
  "amount": 4000,
  "dueDate": "2024-07-12",
  "memo": "Payment for marketing services",
  "barcode": "32994978900005000000001546128483498231955341",
  "digitableLine": "32990001524612848349582319553408497890000500002",
  "payerData": {
    "name": "Global Tech",
    "personType": "legal",
    "documentNumber": "12345678000195",
    "email": "finance@globaltech.com",
    "phone": { … },
    "address": { … }
  },
  "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAY...",
  "bolepixEnabled": true,
  "paymentDetails": {
    "paidAmount": 5000,
    "method": "account_debit",
    "origin": "qr_code",
    "creditDate": "2025-01-15"
  },
  "fine": {
    "type": "absolute",
    "amount": 100,
    "percentage": 10,
    "daysAfterDue": 10
  },
  "interest": {
    "type": "calendar_days_daily_amount",
    "dailyAmount": 100,
    "monthlyPercentage": 10,
    "daysAfterDue": 10
  },
  "metadata": {
    "key1": "value1"
  },
  "createdAt": "2024-06-23T09:15:32Z",
  "updatedAt": "2024-06-26T12:53:47Z"
}

Extend Boleto

Request

Requests a due-date extension for a registered boleto.

Path

idstring[^\/#\?]+?required

Boleto ID (UUID v4).

Headers

Accept-Languagestring

Language code for localization.

Default en-US

Enum"en-US""es-MX""pt-BR"

Example: en-US

Bodyapplication/jsonrequired

BoletoExtendDto

newDueDatestring= 10 charactersrequired

The new due date (ISO 8601 format YYYY-MM-DD).

Example: "2026-09-15"

const id = 'YOUR_id_PARAMETER';
const resp = await fetch(
  `https://public-sandbox.tryjeeves.com/v1/boletos/${id}/extend`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Accept-Language': 'en-US',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      newDueDate: '2026-09-15'
    })
  }
);

const data = await resp.json();
console.log(data);

Responses

Extends a boleto's due date and returns its details.

Bodyapplication/json

idstring= 36 charactersrequired

Unique boleto identification key in uuid v4 format.

Example: "4c2fa514-a44d-40f2-8d57-c0caf1b9165a"

boletoStatusstringnon-emptyrequired

Boleto status.

Enum"accepted""rejected""payment_notice""notary_office_payment_notice""registered""payment_blocked""paid""written_off"

Example: "registered"

amountnumbernon-empty> 0required

The boleto payment amount.

Example: 4000

dueDatestring or string= 10 charactersrequired

The due date (ISO 8601 format YYYY-MM-DD).

Example: "2024-07-12"

One of:

The due date (ISO 8601 format YYYY-MM-DD).

= 10 characters

string(date)= 10 characters

The due date (ISO 8601 format YYYY-MM-DD).

memostring[ 1 .. 320 ] charactersrequired

Optional note for the payer, shown on the boleto.

Example: "Payment for marketing services"

barcodestringnon-emptyrequired

The barcode for the boleto.

Example: "32994978900005000000001546128483498231955341"

digitableLinestringnon-emptyrequired

The digitable line for the boleto.

Example: "32990001524612848349582319553408497890000500002"

payerDataobject(PayerDataDto)required

payerData.namestring[ 1 .. 100 ] charactersrequired

The payer name.

Example: "Global Tech"

payerData.personTypestringnon-emptyrequired

The type of person.

Enum"natural""legal"

Example: "legal"

payerData.documentNumberstring[ 11 .. 14 ] charactersrequired

The payer document number (CPF for natural person - 11 digits, CNPJ for legal person - 14 digits).

Example: "12345678000195"

payerData.emailstring(email)[ 1 .. 320 ] charactersrequired

The payer email address

Example: "finance@globaltech.com"

payerData.phoneobject(PayerPhoneDto)required

payerData.phone.countryCodestring[ 1 .. 3 ] charactersrequired

The payer phone international dial code

Example: "055"

payerData.phone.areaCodestring[ 1 .. 2 ] charactersrequired

The payer phone area code

Example: "11"

payerData.phone.numberstring[ 1 .. 9 ] charactersrequired

The payer phone number

Example: "987654321"

payerData.addressobject(PayerAddressDto)required

payerData.address.streetstring[ 1 .. 500 ] charactersrequired

The payer address street name.

Example: "101 High St."

payerData.address.numberstring[ 1 .. 6 ] charactersrequired

The payer address number.

Example: "202"

payerData.address.complementstring<= 500 characters

The payer address complement.

Example: "Building A"

payerData.address.neighborhoodstring[ 1 .. 100 ] charactersrequired

The payer address neighborhood.

Example: "Tech Park"

payerData.address.postalCodestring= 8 charactersrequired

The payer address postal code (CEP).

Example: "01001000"

payerData.address.citystring[ 1 .. 100 ] charactersrequired

The payer address city.

Example: "São Paulo"

payerData.address.statestringnon-emptyrequired

The payer address state.

Enum"AC""AL""AM""AP""BA""CE""DF""ES""GO""MA"

Example: "SP"

qrCodeImagestring

QR code image in base64 format for BolePix payments.

Example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAY..."

bolepixEnabledboolean

If true, generates a BolePix boleto with a Pix QR code.

Default true

paymentDetailsobject(PaymentDetailsDto)

fineobject(FineDto)

Fine to be applied.

interestobject(InterestDto)

Interest to be applied.

metadataobject

Boleto metadata.

Example: {"key1":"value1"}

createdAtstring or stringnon-emptyrequired

Creation date (ISO 8601).

Example: "2024-06-23T09:15:32Z"

One of:

Creation date (ISO 8601).

non-empty

string(date)non-empty

Creation date (ISO 8601).

updatedAtstring or string

Updated at (ISO 8601).

Example: "2024-06-26T12:53:47Z"

One of:

Updated at (ISO 8601).

string(date)

Updated at (ISO 8601).

Response

application/json

{
  "id": "4c2fa514-a44d-40f2-8d57-c0caf1b9165a",
  "boletoStatus": "registered",
  "amount": 4000,
  "dueDate": "2024-07-12",
  "memo": "Payment for marketing services",
  "barcode": "32994978900005000000001546128483498231955341",
  "digitableLine": "32990001524612848349582319553408497890000500002",
  "payerData": {
    "name": "Global Tech",
    "personType": "legal",
    "documentNumber": "12345678000195",
    "email": "finance@globaltech.com",
    "phone": { … },
    "address": { … }
  },
  "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAY...",
  "bolepixEnabled": true,
  "paymentDetails": {
    "paidAmount": 5000,
    "method": "account_debit",
    "origin": "qr_code",
    "creditDate": "2025-01-15"
  },
  "fine": {
    "type": "absolute",
    "amount": 100,
    "percentage": 10,
    "daysAfterDue": 10
  },
  "interest": {
    "type": "calendar_days_daily_amount",
    "dailyAmount": 100,
    "monthlyPercentage": 10,
    "daysAfterDue": 10
  },
  "metadata": {
    "key1": "value1"
  },
  "createdAt": "2024-06-23T09:15:32Z",
  "updatedAt": "2024-06-26T12:53:47Z"
}

Cards

The Card API supports the full card lifecycle, enabling clients to create, retrieve, and update cards via secure integration. Use POST /v1/cards/transactions with the source field to query card or travel transactions in a single endpoint.

Operations

Transactions

The Transactions API enables clients to retrieve card and payment transactions via secure integration. Supports filtering by date range and pagination for efficient data retrieval.

Operations

Travel

The Travel API enables clients to retrieve transactions from virtual travel cards and update booking details via secure integration.

Operations

Webhooks

The Webhooks API provides access to webhook subscription management and event tracking, enabling you to receive real-time HTTP notifications the moment a card transaction is approved, declined, settled, or fails.

Operations

Jeeves Public API (1.0.0)

Introduction

Authentication

Errors

Boletos

List Boletos

Request

Responses

Was this helpful?

Create Boleto

Request

Responses

Was this helpful?

Get Boleto by ID

Request

Responses

Was this helpful?

Cancel Boleto

Request

Responses

Was this helpful?

Extend Boleto

Request

Responses

Was this helpful?

Cards

Transactions

Travel

Webhooks

Jeeves Public API (1.0.0)

Introduction

Authentication

Errors

Boletos

List Boletos

Request

Responses

Was this helpful?

Create Boleto

RequestExpand all

Responses

Was this helpful?

Get Boleto by ID

Request

Responses

Was this helpful?

Cancel Boleto

Request

Responses

Was this helpful?

Extend Boleto

Request

Responses

Was this helpful?

Cards

Transactions

Travel

Webhooks

Request