OpenAPI definition (v1.0.5)
Download OpenAPI specification:Download
Billets list.
Fetch billets using parameters
query Parameters
| event_date | string Enum: "CREATED_AT" "DUE_DATE" "PAY_DATE" |
| event_date_start | string |
| event_date_end | string |
| page_offset | integer <int32> Default: 0 |
| page_limit | integer <int32> Default: 10 |
| sort_by | string Default: "EVENT_DATE" |
| sort_type | string Default: "ASC" |
| filter | string Enum: "debtor_document" "customer_internal_ctrl_title_number" "bank_title_number" |
header Parameters
| Authorization required | string |
Responses
Response Schema: */*
object (MetaData) | |
Array of objects (BilletResponseDto) |
Create a new billet.
Create a new billet
header Parameters
| Authorization required | string |
| x-idempotency-key required | string |
Request Body schema: application/jsonrequired
| customerTitleNumber | string |
| customerInternalCtrlTitleNumber required | string |
| titleIssuanceDate required | string |
| titleDueDate required | string |
| faceTitleAmount required | number <double> > 0 |
| iofAmount required | number <double> >= 0 |
required | object (PersonDto) |
object (InterestDto) | |
object (PenaltyDto) | |
Array of objects (DiscountDto) |
Responses
Response Schema: */*
| id | string |
| accountId | string |
| status | string Enum: "CREATED" "WAITING_BANK" "WAITING_PAYMENT" "BANK_REGISTER_FAILED" "REJECTED_BY_BANK" "CANCELED" "PAID" "WAITING_CASH_IN" "SETTLED" Billet actual state: |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| barcode | string |
| digitableLine | string |
| bankTitleNumber | string |
| customerTitleNumber | string |
| customerInternalCtrlTitleNumber | string |
| titleIssuanceDate | string |
| titleDueDate | string |
| faceTitleAmount | number <double> |
| iofAmount | number <double> |
object (PersonDto) | |
object (InterestDto) | |
object (PenaltyDto) | |
Array of objects (DiscountDto) | |
object (PaymentDto) | |
Array of objects (StatusHistoryDto) |
Request samples
- Payload
Content type
application/json
{- "customerTitleNumber": "string",
- "customerInternalCtrlTitleNumber": "string",
- "titleIssuanceDate": "string",
- "titleDueDate": "string",
- "faceTitleAmount": 0.1,
- "iofAmount": 0.1,
- "debtor": {
- "name": "string",
- "documentType": "CPF",
- "documentNumber": "string",
- "street": "string",
- "streetNumber": "string",
- "complement": "string",
- "neighborhoodName": "string",
- "municipalityName": "string",
- "stateAbbreviation": "string",
- "postalCode": "string",
- "emailAddress": "string",
- "phoneNumber": "string"
}, - "interest": {
- "termType": "CALENDAR_DAYS",
- "daysAfterDueDate": 0,
- "valueType": "CURRENCY",
- "amount": 0.1
}, - "penalty": {
- "termType": "CALENDAR_DAYS",
- "daysAfterDueDate": 0,
- "valueType": "CURRENCY",
- "amount": 0.1
}, - "discounts": [
- {
- "valueType": "CURRENCY",
- "deadline": "string",
- "amount": 0.1
}
]
}Manually settlement a billet.
Settle a billet
path Parameters
| id required | string |
header Parameters
| Authorization required | string |
Responses
Response Schema: */*
| id | string |
| idempotencyKey | string |
| accountId | string |
| status | string Enum: "CREATED" "WAITING_BANK" "WAITING_PAYMENT" "BANK_REGISTER_FAILED" "REJECTED_BY_BANK" "CANCELED" "PAID" "WAITING_CASH_IN" "SETTLED" |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| barcode | string |
| digitableLine | string |
| bankTitleNumber | string |
| customerTitleNumber | string |
| customerInternalCtrlTitleNumber | string |
| titleIssuanceDate | string |
| titleDueDate | string |
| faceTitleAmount | number <double> |
| iofAmount | number <double> |
object (Person) | |
object (Interest) | |
object (Penalty) | |
Array of objects (Discount) | |
object (Payments) | |
Array of objects (StatusHistory) | |
| schemaVersion | integer <int32> |
Request a billet reprocess.
Billet reprocess
path Parameters
| id required | string |
header Parameters
| Authorization required | string |
Responses
Response Schema: */*
| id | string |
| accountId | string |
| status | string Enum: "CREATED" "WAITING_BANK" "WAITING_PAYMENT" "BANK_REGISTER_FAILED" "REJECTED_BY_BANK" "CANCELED" "PAID" "WAITING_CASH_IN" "SETTLED" Billet actual state: |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| barcode | string |
| digitableLine | string |
| bankTitleNumber | string |
| customerTitleNumber | string |
| customerInternalCtrlTitleNumber | string |
| titleIssuanceDate | string |
| titleDueDate | string |
| faceTitleAmount | number <double> |
| iofAmount | number <double> |
object (PersonDto) | |
object (InterestDto) | |
object (PenaltyDto) | |
Array of objects (DiscountDto) | |
object (PaymentDto) | |
Array of objects (StatusHistoryDto) |
Get a billet by ID.
Get billet by internal ID.
path Parameters
| id required | string |
header Parameters
| Authorization required | string |
Responses
Response Schema: */*
| id | string |
| idempotencyKey | string |
| accountId | string |
| status | string Enum: "CREATED" "WAITING_BANK" "WAITING_PAYMENT" "BANK_REGISTER_FAILED" "REJECTED_BY_BANK" "CANCELED" "PAID" "WAITING_CASH_IN" "SETTLED" |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| barcode | string |
| digitableLine | string |
| bankTitleNumber | string |
| customerTitleNumber | string |
| customerInternalCtrlTitleNumber | string |
| titleIssuanceDate | string |
| titleDueDate | string |
| faceTitleAmount | number <double> |
| iofAmount | number <double> |
object (Person) | |
object (Interest) | |
object (Penalty) | |
Array of objects (Discount) | |
object (Payments) | |
Array of objects (StatusHistory) | |
| schemaVersion | integer <int32> |