Skip to main content
POST
/
orders
/
quote
Create a currency quote
curl --request POST \
  --url https://api.equalsmoney.com/v2/orders/quote \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceCurrency": {
    "amount": 0,
    "currency": {
      "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
      "currencyCode": "USD"
    }
  },
  "targetCurrency": {
    "amount": 0,
    "currency": {
      "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
      "currencyCode": "USD"
    }
  },
  "settlementDate": "20221027",
  "type": {
    "from": "bank",
    "to": "payment",
    "recipientId": "8lciyups6"
  }
}
'
{
  "orderId": "EABCDE6FGHI0",
  "quoteRequestId": "USD-USD-5-5",
  "settlement": {
    "date": "20221027",
    "price": {
      "amount": 5,
      "currency": "USD"
    },
    "charges": {
      "fee": 0,
      "margin": 0,
      "other": 0
    }
  },
  "quote": {
    "rate": 1,
    "inverseRate": 1,
    "fromGbpAmount": 3,
    "from": {
      "amount": 5,
      "currency": "USD"
    },
    "to": {
      "amount": 5,
      "currency": "USD"
    },
    "direction": 1
  }
}

Authorizations

Authorization
string
header
required

Query Parameters

accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Body

application/json

Body

sourceCurrency
object
required

Details about the source currency.

targetCurrency
object
required

Details about the target currency.

settlementDate
string
required

The settlement date.

Pattern: ^20[0-9]{2}[0-2][0-9][0-3][0-9]$
Example:

"20221027"

type
object
required

Details about the type of quote that you're creating.

Response

200 - application/json

OK

orderId
string

The ID of the order.

Example:

"EABCDE6FGHI0"

quoteRequestId
string

The ID of the quote request.

Example:

"USD-USD-5-5"

settlement
object

Details about the settlement.

quote
object

Details about the quote.