Skip to main content

Get Quote by ID

GET 
/v1/crossborder/quotes/:id

Retrieve detailed information about a specific crossborder quote by providing the quote ID.

Request​

Path Parameters

    id stringrequired

    Quote ID.

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.

    x-wallet-uuid string

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

Responses​

Quote returned successfully.

Schema
    id stringrequired

    Quote ID.

    rate_id stringrequired

    Rate ID.

    client objectrequired
    id stringrequired

    Client ID.

    name stringrequired

    Client name.

    email stringrequired

    Client email.

    type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Client type.

    country object

    Client country.

    phone_number string

    Client phone number.

    document stringrequired

    Client document.

    client_account object
    account_type stringrequired

    Possible values: [CHECKING, SAVINGS]

    Client account type.

    account_number stringrequired

    Client account number.

    branch string

    Client branch.

    bank_name stringrequired

    Client bank name.

    bank_code stringrequired

    Client bank code.

    counterparty objectrequired
    id stringrequired

    Counterparty ID.

    name stringrequired

    Counterparty name.

    email stringrequired

    Counterparty email.

    type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Counterparty type.

    country objectrequired

    Counterparty country.

    phone_number string

    Client phone number.

    document stringrequired

    Client document.

    counterparty_account object
    account_type stringrequired

    Possible values: [CHECKING, SAVINGS]

    Counterparty account type.

    account_number stringrequired

    Counterparty account number.

    branch string

    Counterparty branch.

    bank_name stringrequired

    Counterparty bank name.

    bank_code stringrequired

    Counterparty bank code.

    deposit_info objectrequired
    bank_name stringrequired

    Bank name for deposit.

    bank_code string

    Bank code.

    branch string

    Bank account branch.

    beneficiary_account string

    Beneficiary account number.

    beneficiary_name stringrequired

    Beneficiary name.

    beneficiary_document stringrequired

    Beneficiary document.

    status stringrequired

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

    Quote status.

    base_currency objectrequired

    Base currency symbol.

    quote_currency objectrequired

    Quote currency symbol.

    base_amount numberrequired

    Base amount in cents.

    quote_amount numberrequired

    Quote amount in cents.

    side stringrequired

    Possible values: [buy, sell]

    Quote side (buy or sell).

    fx_rate numberrequired

    Foreign exchange rate.

    spread numberrequired

    Spread in basis points (bps).

    tax numberrequired

    Tax amount in cents.

    vet numberrequired

    VET (tax/fee) in cents.

    description string

    Description.

    liquidity stringrequired

    Liquidity provider.

    settlement_type stringrequired

    Possible values: [D0, D1, D2, D3]

    Settlement type.

    settlement_at date-time

    Settlement date.

    paid_at date-time

    Paid date.

    approval_at date-time

    Approval date.

    rejection_at date-time

    Rejection date.

    cancellation_at date-time

    Cancellation date.

    failure_at date-time

    Failure date.

    reversal_at date-time

    Reversal date.

    created_at date-timerequired

    Quote created date.

    updated_at date-timerequired

    Quote updated date.

Loading...