ReapQuoteSimulator

post/v1/portfolio/{portfolioSlug}/reap/simulate-quote

Request

  • Base URL: https://api.tokenbooks.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.tokenbooks.io/v1/portfolio/{portfolioSlug}/reap/simulate-quote
  • Auth: API key in header x-api-key

Path parameters

portfolioSlugstring required

Workspace-scoped portfolio slug

Request body

network'SWIFT' | 'ACH' | 'SEPA' | 'FPS' | 'EFT' | 'FAST' | 'CHATS' | 'KFTC' | 'ZENGIN' | 'INSTAPAY' | 'PESONET' | 'PROMPTPAY' | 'BECS' | 'IMPS' | 'NEFT' | 'BI-FAST' | 'UAEFTS' | 'SPEI' | 'SPID' | 'PIX' required

Reap payout network / bank method (e.g. SEPA, ACH, IMPS)

receivingAmountstring required

Amount the recipient should receive, as a decimal string in the receiving currency (e.g. "500000")

receivingCurrencystring

ISO 4217 receiving currency; defaults to the network default

recipientBankCountrystring

ISO 3166-1 alpha-2 recipient bank country; defaults to the network default

senderCurrency'USDC' | 'USDT' | 'USDe'

Stablecoin funding the simulated payout

purposeOfPayment'payment_for_goods' | 'payment_for_business_services' | 'payment_for_salary_or_benefits' | 'capital_investment_or_item' | 'other'

Reap purpose-of-payment classification

Response

status'quoted' | 'corridor_unavailable' | 'amount_out_of_range' | 'limit_skipped' required
notestring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.