Skip to main content

Update Quote

PATCH 
/v1/crossborder/quotes/:id

Update an existing crossborder quote. Only the description field can be updated.

Request​

Path Parameters

    id stringrequired

    Quote ID.

Header Parameters

    x-include-replay-protection-schema string

    The replay-protection-schema allows the user to choose between 3 options:

    • If there's no value: The default protection checks that the values in this request are equal: { method, params, path, query, body, userId }. This means that if a request repeats the same values, it will be blocked.
    • 'nonce': The nonce and { method, params, path, query, body, userId } value are checked. When the protection schema is this, requests will be OK if this nonce value is different in each request.
    • 'x-transaction-uuid': The transactionId and { method, params, path, query, body, userId } value are checked. Requests will be OK if this x-transaction-uuid value is different in each request.
    • 'x-transaction-uuid&nonce' or 'nonce&x-transaction-uuid': The nonce, transactionId value and { method, params, path, query, body, userId } are checked, i.e. if requests are repeated the same value in both fields, they will be blocked. But if any field has a different value, the request is OK.

    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.

Body

required
    description string

    Description.

Responses​

Quote updated successfully.

Schema
    id stringrequired

    Quote ID.

    rate_id stringrequired

    Rate ID.

    owner_id stringrequired

    Owner ID (Client ID).

    owner_name stringrequired

    Owner name.

    beneficiary_id stringrequired

    Beneficiary ID (Client ID).

    beneficiary_name stringrequired

    Beneficiary name.

    status stringrequired

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

    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.

    spread numberrequired

    Spread in basis points (bps).

    vet numberrequired

    VET (tax/fee) in cents.

    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...