Debt Lines

Estimate what a draw pays the payout account, converted at the current rate

get/debt-lines/{id}/draw/estimate

Request

Base URL
https://core.sivo.com
Auth
- API key in header Authorization
- or OAuth 2
  Authorization codehttps://dashboard.sivo.com/oauth/authorize
  Client credentials
  Token URLhttps://core.sivo.com/oauth/token
TypeScript
https://skmtc.dev/sivo/apis/sivo-advance-api/docs/debt-lines/:id/draw/estimate/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

amountnumber nullable

amount of principal to draw, in the debt line currency

Successful operation

amountinteger required

amount of principal to draw

currencystring required

debt line currency

payment_amountinteger required

estimated amount the payout account receives, in payment_currency

payment_currencystring required

currency of the payout account the draw is sent to

fx_ratenumber

indicative rate quoted in fx_currency_pair order; omitted when no conversion is needed

fx_currency_pairstring

currency pair fx_rate is quoted in, e.g. USDINR

{
  "amount": 10000,
  "currency": "USD",
  "payment_amount": 10000,
  "payment_currency": "USD"
}