GetAllQuoteRestResponse

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.
account_name string
Friendly client account name.
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.
nickname string
Nickname to identify the counterparty.
type string
Possible values: [NATURAL_PERSON, LEGAL_PERSON]
Counterparty type.
country object
Counterparty country.
relationship string
Possible values: [EMPLOYEE, CONTRACTOR, VENDOR, SUBSIDIARY, MERCHANT, CUSTOMER, LANDLORD, FAMILY, OTHER]
Relationship to the beneficiary.
status string
Possible values: [ACTIVE, INACTIVE, PENDING, REJECTED, EXPIRED]
Counterparty lifecycle / verification status.
created_at date-time
Counterparty created date.
updated_at date-time
Counterparty updated date.
counterparty_account object
id stringrequired
Counterparty account ID.
account_type string
Possible values: [CHECKING, SAVINGS]
Counterparty account type.
account_number string
Counterparty account number.
account_name string
Friendly counterparty account name.
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: [AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]
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.
]
transaction_verifications object[]
Transaction verifications linked to the quote, when present.
Array [
id stringrequired
Transaction verification ID.
quote_id string
Quote ID.
type stringrequired
Transaction verification type (e.g. provider or workflow key).
props object
Provider or workflow payload for the verification.
created_at date-timerequired
Created at.
updated_at date-timerequired
Updated at.
]
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.
]