Get All Quotes

GET 
/v1/crossborder/quotes

Retrieve a list of all crossborder quotes. Optional filter parameters can be used to refine your search.

Request

Query Parameters

page number

Default value: 1

Page number.

size number

Possible values: <= 100

Default value: 20

Page size. Max size is 100.

sort string

Possible values: [created_at, settlement_date, paid_at, updated_at]

Page sort attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

client_document string

Filter by client document.

status string

Possible values: [PENDING, CREATED, APPROVED, PAID, SETTLED, FAILED]

Filter by status.

base_currency_symbol string

Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]

Filter by base currency (destination currency).

quote_currency_symbol string

Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]

Filter by quote currency (origin currency).

settlement_date date-time

Filter by settlement date (format: YYYY-MM-DD).

created_at_start date-time

Start date of the created at period in the format YYYY-MM-DD.

created_at_end date-time

End date of the created at period in the format YYYY-MM-DD.

Header Parameters

x-wallet-uuid string

Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

x-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

x-product-uuid string

UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

x-product-target-user-uuid string

UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Responses

200

Quotes returned successfully.

application/json

Schema

Schema

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
Quotes data.
Array [
id stringrequired
Quote ID.
status stringrequired
Possible values: [PENDING, CREATED, APPROVED, PAID, SETTLED, FAILED]
Status.
rate objectrequired
id stringrequired
Rate ID.
base_currency_symbol stringrequired
Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]
Base currency symbol.
base_currency_decimals numberrequired
Base currency decimals.
quote_currency_symbol stringrequired
Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]
Quote currency symbol.
quote_currency_decimals numberrequired
Quote currency decimals.
side stringrequired
Possible values: [BUY, SELL]
Side.
price numberrequired
Price.
price_decimals numberrequired
Price decimals.
fees object[]required
Fees charged.
Array [
name stringrequired
Possible values: [SYSTEM_SPREAD, CLIENT_EXTRA_SPREAD, IOF]
Fee name.
fee numberrequired
Fee.
fee_format stringrequired
Possible values: [PERCENTAGE]
Fee format.
amount numberrequired
Fee total amount charged in cents.
amount_decimals numberrequired
Amount decimals.
amount_currency_symbol stringrequired
Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]
Amount currency symbol.
]
vet numberrequired
VET.
base_currency_amount numberrequired
Base currency amount in cents.
quote_currency_amount numberrequired
Quote currency amount in cents.
settlement_date_code stringrequired
Possible values: [D0, D1, D2]
Settlement date code.
settlement_date date-timerequired
Settlement date in YYYY-MM-DD format.
expires_at date-timerequired
Expiration date in YYYY-MM-DDTHH:mm:ss.SSSZ format.
created_at date-timerequired
Creation date in YYYY-MM-DDTHH:mm:ss.SSSZ format.
client objectrequired
id stringrequired
Client ID.
name stringrequired
Client name. For legal entities, the name field corresponds to the legal name.
email string
Client email.
type string
Possible values: [NATURAL_PERSON, LEGAL_PERSON]
Client type.
country object
Client country.
phone_number string
Client phone number.
document string
Client document.
client_account objectrequired
id stringrequired
Client account ID.
account_type string
Possible values: [CHECKING, SAVINGS]
Client account type.
account_number string
Client account number.
branch string
Client branch.
bank_name string
Client bank name.
bank_code string
Client bank code.
client_wallet objectrequired
id stringrequired
Client wallet ID.
counterparty objectrequired
id stringrequired
Counterparty ID.
name stringrequired
Counterparty name. For legal entities, the name field corresponds to the legal name.
email string
Counterparty email.
type string
Possible values: [NATURAL_PERSON, LEGAL_PERSON]
Counterparty type.
country object
Counterparty country.
phone_number string
Counterparty phone number.
document string
Counterparty document.
counterparty_account object
id stringrequired
Counterparty account ID.
account_type string
Possible values: [CHECKING, SAVINGS]
Counterparty account type.
account_number string
Counterparty account number.
branch string
Counterparty branch.
bank_name string
Counterparty bank name.
bank_code string
Counterparty bank code.
counterparty_wallet object
id stringrequired
Counterparty wallet ID.
deposit_info objectrequired
currency_symbol stringrequired
Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]
Currency symbol.
country_code string
Possible values: [US, BR, MX, AR, CO, CL, PE, EC, UY, PY]
Country code.
type stringrequired
Possible values: [TED]
Type.
details objectrequired
Beneficiary document.
quote_documents object[]required
Quote documents.
Array [
id stringrequired
Quote document ID.
quote_id stringrequired
Quote ID.
user_id stringrequired
User ID.
wallet_id stringrequired
Wallet ID.
file_id string
File ID.
name stringrequired
Document name.
description string
Document description.
type stringrequired
Possible values: [IDENTITY, PROOF_OF_ADDRESS, BANK_STATEMENT, INVOICE, CONTRACT, OTHER]
Document type.
status stringrequired
Possible values: [PENDING_ANALYSIS, APPROVED, REJECTED]
Document status.
rejection_reason string
Document rejection reason.
created_at date-timerequired
Document created date.
updated_at date-timerequired
Document updated date.
]
wallet_owner_name string
Wallet owner (company) name.
description string
Description.
purpose string
Purpose of the quote.
approval_at date-time
Approval date.
paid_at date-time
Paid date.
settled_at date-time
Settled date.
failure_at date-time
Failure date.
created_at date-timerequired
Quote created date.
updated_at date-timerequired
Quote updated date.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
      "status": "PENDING",
      "rate": {
        "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
        "base_currency_symbol": "USD",
        "base_currency_decimals": 2,
        "quote_currency_symbol": "BRL",
        "quote_currency_decimals": 2,
        "side": "BUY",
        "price": 5.1234,
        "price_decimals": 4,
        "fees": [
          {
            "name": "SYSTEM_SPREAD",
            "fee": 1,
            "fee_format": "PERCENTAGE",
            "amount": 100,
            "amount_decimals": 4,
            "amount_currency_symbol": "BRL"
          }
        ],
        "vet": 5.1234,
        "base_currency_amount": 10000,
        "quote_currency_amount": 51234,
        "settlement_date_code": "D0",
        "settlement_date": "2026-03-26",
        "expires_at": "2026-03-26T14:02:59.411Z",
        "created_at": "2026-03-26T14:02:59.411Z"
      },
      "client": {
        "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
        "name": "John Doe",
        "email": "john.doe@example.com",
        "type": "NATURAL_PERSON",
        "country": "US",
        "phone_number": "+5511999999999",
        "document": "12345678901"
      },
      "client_account": {
        "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
        "account_type": "CHECKING",
        "account_number": "12345-6",
        "branch": "0001",
        "bank_name": "Bank of America",
        "bank_code": "001"
      },
      "client_wallet": {
        "id": "f6e2e084-29b9-4935-a059-5473b13033aa"
      },
      "counterparty": {
        "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
        "name": "John Doe",
        "email": "john.doe@example.com",
        "type": "NATURAL_PERSON",
        "country": "US",
        "phone_number": "+5511999999999",
        "document": "12345678901"
      },
      "counterparty_account": {
        "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
        "account_type": "CHECKING",
        "account_number": "12345-6",
        "branch": "0001",
        "bank_name": "Bank of America",
        "bank_code": "001"
      },
      "counterparty_wallet": {
        "id": "f6e2e084-29b9-4935-a059-5473b13033aa"
      },
      "deposit_info": {
        "currency_symbol": "BRL",
        "country_code": "BR",
        "type": "TED",
        "details": "12345678901"
      },
      "quote_documents": [
        {
          "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
          "quote_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
          "user_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
          "wallet_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
          "file_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
          "name": "Identity Document",
          "description": "Front side of identity document",
          "type": "IDENTITY",
          "status": "PENDING_ANALYSIS",
          "rejection_reason": "Document is expired",
          "created_at": "2026-03-26T14:02:59.410Z",
          "updated_at": "2026-03-26T14:02:59.410Z"
        }
      ],
      "wallet_owner_name": "Acme Corp LTDA",
      "description": "Payment for services",
      "purpose": "INTERNATIONAL_PERSONAL_REMITTANCE",
      "approval_at": "2026-03-26T14:02:59.413Z",
      "paid_at": "2026-03-26T14:02:59.413Z",
      "settled_at": "2026-03-26T14:02:59.413Z",
      "failure_at": "2026-03-26T14:02:59.413Z",
      "created_at": "2026-03-26T14:02:59.413Z",
      "updated_at": "2026-03-26T14:02:59.413Z"
    }
  ]
}

401

User authentication failed.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 401,
  "error": "USER",
  "message": "Access is denied."
}

403

User access denied.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 403,
  "error": "USER",
  "message": "Access denied to requested resource. User may not have sufficient permission."
}

422

If any required params are missing or have invalid format or type.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 422,
  "error": "USER",
  "message": "Invalid quote currency amount. The minimum allowed is 100, and you requested 61.",
  "code": "INVALID_QUOTE_CURRENCY_MIN_AMOUNT"
}

Loading...