# Quote

Create quote for use with payment

Endpoint: POST /v2/quote
Version: 3.0.0
Security: bearerAuth

## Security:

  - `bearerAuth` (unknown)
    http bearer JWT

## Request fields (application/json):

  - `country` (string, required)
    Enum: "BGD", "IND", "PAK", "PHL", "NPL", "EGY", "VNM", "NGA"

  - `currency` (string, required)
    Enum: "BHD", "EUR", "KWD", "MYR", "OMR", "QAR", "SAR", "SGD", "TRY", "AED", "USD", "INR", "PHP", "EGP", "VND", "PKR", "NGN"

  - `beneficiary_account_number` (any)
    Bank account id of the beneficiary. [OPTIONAL]

  - `bank_branch_code` (any)
    Bank branch code of the beneficiary (e.g. IFSC for India) [OPTIONAL]

  - `amount` (number, required)
    The amount to convert, in the SOURCE currency - the one named in `currency` (e.g. AED, USD), not the destination country's.
Rounded to 4 decimal places.

  - `amount_destination` (number, required)
    The amount the beneficiary is to receive, in the DESTINATION country's local currency (e.g INR for `country=IND`);
`currency` remains the SOURCE currency you fund from. Rounded to 2 decimal places.

## Response 200:

  - `200` (unknown)
    Successful Response

## Response 200 fields (application/json):

  - `id` (string, required)
    Quote id. Send it as `quote` on `POST /v2/payment`; a quote can back one payment only.

  - `country` (string, required)
    Enum: "BGD", "IND", "PAK", "PHL", "NPL", "EGY", "VNM", "NGA"

  - `currency` (string, required)
    Enum: "BHD", "EUR", "KWD", "MYR", "OMR", "QAR", "SAR", "SGD", "TRY", "AED", "USD", "INR", "PHP", "EGP", "VND", "PKR", "NGN"

  - `amount` (number, required)
    What you pay, in the source currency.

  - `amount_destination` (number, required)
    What the beneficiary receives, in the destination currency. Send it verbatim as `amount` on `POST /v2/payment`.

  - `rate` (number, required)
    Exchange rate from the source currency to the destination currency. This is the rate your customer sees.

  - `timestamp` (string, required)
    When the quote was issued (UTC).

  - `expires` (string, required)
    When the quote stops being usable (UTC), currently 15 minutes after `timestamp`. Read this value rather than hard-coding the window.

  - `wallet_rate` (number, required)
    Exchange rate from your settlement wallet currency to the destination currency. For settlement only: do not show it to your customer or use it to compute a payout.

  - `min_amount_destination` (any)
    Smallest payout your account may send on this corridor, in the destination currency. Set per account, so read it from every quote rather than caching it.

  - `max_amount_destination` (any)
    Largest payout your account may send on this corridor, in the destination currency. Set per account, so read it from every quote rather than caching it.

## Response 400:

  - `400` (unknown)
    Bad data in the request

## Response 400 fields (application/json):

  - `detail` (any)

## Response 401:

  - `401` (unknown)
    Access token not valid or expired

## Response 401 fields (application/json):

  - `detail` (any)

## Response 403:

  - `403` (unknown)
    Access token missing permissions to access the resource

## Response 403 fields (application/json):

  - `detail` (any)

## Response 422:

  - `422` (unknown)
    Unprocessable Entry

## Response 422 fields (application/json):

  - `detail` (any)

## Response 429:

  - `429` (unknown)
    Request rate is too high; back off and retry. Where a `retry-after` response header is present it gives the number of seconds to wait.

## Response 429 fields (application/json):

  - `detail` (any)

## Response 429 headers (application/json):

  - `retry-after` (integer)
    Seconds to wait before retrying this request.

## Response 500:

  - `500` (unknown)
    Internal server error (contact administrator)

## Response 500 fields (application/json):

  - `detail` (any)

## Response 400 examples:

  - `Unable to fetch quote (min/max amount requirements)` (unknown)

## Response 500 examples:

  - `Could not obtain quote.` (unknown)

  - `Could not fetch quote at this time.` (unknown)

