Skip to main content

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 object

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    status string

    Possible values: [PENDING, APPROVED, REJECTED, PAID, CANCELED]

    Filter by status.

    base_currency string

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

    Filter by base currency (origin currency).

    quote_currency string

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

    Filter by quote currency (destination currency).

    spread number

    Filter by spread (bps = Percentage * 100).

    settlement_at date-time

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

    created_at date-time

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

Header Parameters

    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

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

Quotes returned successfully.

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.

    rate_id stringrequired

    Rate ID.

    client_id stringrequired

    Client ID.

    client_name stringrequired

    Client name.

    counterparty_id stringrequired

    Counterparty ID.

    counterparty_name stringrequired

    Counterparty name.

    status stringrequired

    Possible values: [PENDING, APPROVED, REJECTED, PAID, CANCELED]

    Quote status.

    base_currency objectrequired

    Base currency symbol (origin currency).

    quote_currency objectrequired

    Quote currency symbol (destination currency).

    base_amount numberrequired

    Base amount in cents (origin amount).

    quote_amount numberrequired

    Quote amount in cents (destination amount).

    spread numberrequired

    Spread in basis points (bps).

    tax numberrequired

    Tax in cents.

    vet numberrequired

    VET (tax/fee) in cents.

    client_account object
    id stringrequired

    Account ID.

    country stringrequired

    Possible values: [US, BR, MX, AR, CO, CL, PE, EC, UY, PY]

    Country code.

    currency_symbol stringrequired

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

    Currency symbol.

    account_type stringrequired

    Possible values: [CHECKING, SAVINGS]

    Account type.

    account_number stringrequired

    Account number.

    branch string

    Branch.

    bank_name stringrequired

    Bank name.

    bank_code stringrequired

    Bank code.

    bank_code_type stringrequired

    Possible values: [ABA, BIC, IBAN, CLABE, CBU, FEBRABAN, BSB, IFSC, SORT_CODE, TRANSIT_NUMBER]

    Bank code type.

    created_at date-timerequired

    Created at.

    updated_at date-timerequired

    Updated at.

    counterparty_account object
    id stringrequired

    Account ID.

    country stringrequired

    Possible values: [US, BR, MX, AR, CO, CL, PE, EC, UY, PY]

    Country code.

    currency_symbol stringrequired

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

    Currency symbol.

    account_type stringrequired

    Possible values: [CHECKING, SAVINGS]

    Account type.

    account_number stringrequired

    Account number.

    branch string

    Branch.

    bank_name stringrequired

    Bank name.

    bank_code stringrequired

    Bank code.

    bank_code_type stringrequired

    Possible values: [ABA, BIC, IBAN, CLABE, CBU, FEBRABAN, BSB, IFSC, SORT_CODE, TRANSIT_NUMBER]

    Bank code type.

    created_at date-timerequired

    Created at.

    updated_at date-timerequired

    Updated at.

    description string

    Description.

    settlement_type stringrequired

    Possible values: [D1, D2, D3]

    Settlement type.

    settlement_at date-time

    Settlement date.

    paid_at date-time

    Paid date.

    created_at date-timerequired

    Quote created date.

    updated_at date-timerequired

    Quote updated date.

  • ]
Loading...