v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Offer

Find offers by query filters.

Retrieve offers based on query parameters

Recuperar ofertas com base nos parâmetros de consulta

get/offers

Query parameters

card_networkstring

CardNetwork of the offer

Bandeira da planilha

currencystring

Currency type of the offer

Tipo da moeda

offer_valuestring

OfferValue of the offer

Valor da oferta

receivable_total_valuestring

ReceivableTotalValue of the offer

Valor total dos recebíveis da oferta

acquirer_idinteger[]

AcquirerID of the offer

CompanyID do adquirente da oferta

investor_idinteger[]

InvestorID of the offer

CompanyID do investidor da oferta

statusstring[]

Status of the offer

Status de oferta

created_greater_or_equal_thanstring

Created date greater or equal to (YYYY-MM-DD)

Data de criação maior ou igual a (AAAA-MM-DD)

created_less_or_equal_thanstring

Created date less or equal to (YYYY-MM-DD)

Data de criação menor ou igual a (AAAA-MM-DD)

expire_date_greater_or_equal_thanstring

Expire date greater or equal to (YYYY-MM-DD)

Data de expiração maior ou igual a (AAAA-MM-DD)

expire_date_less_or_equal_thanstring

Expire date less or equal to (YYYY-MM-DD)

Data de expiração menor ou igual a (AAAA-MM-DD)

Response

List of users matching the filters | Lista de usuários que correspondem aos filtros

limitinteger

pageinteger

sortstring

total_pagesinteger

total_rowsinteger

Example response

{
  "limit": 10,
  "page": 1,
  "rows": [
    {
      "card_network": "MASTERCARD",
      "company_id": 123,
      "created_at": "2025-01-29T10:38:00.694798-03:00",
      "currency": "BRL",
      "expire_date": "2025-01-30T10:38:00.694798-03:00",
      "id": 1,
      "minimal_value": 100,
      "offer_value": 200,
      "receivable_total_value": 300,
      "status": "CANCELED",
      "total_proposals": 3,
      "total_transaction_numbers": 50,
      "updated_at": "2025-01-29T10:38:00.694798-03:00",
      "user_id": 7
    }
  ],
  "sort": "created_at desc",
  "total_pages": 1,
  "total_rows": 1
}