{"openapi":"3.0.3","info":{"title":"Exchange","version":"1.0","description":"APIs for Verto exchange now service.","x-logo":{"url":""}},"paths":{"/fx/{reference}":{"get":{"operationId":"client_get_fx_order","x-atlas-api":true,"x-permission-config":["Client:At Verto Rate:read"],"tags":["Trade"],"parameters":[{"$ref":"#/components/parameters/referenceParam"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientOrderResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get FX trade details","description":"Retrieve a single FX trade by reference and review its currencies, amount, rate, settlement state, payment details, and timestamps."}},"/fx/rate":{"post":{"deprecated":true,"operationId":"client_get_fx_rate","x-atlas-api":true,"x-permission-config":["Client:At Verto Rate:read","Admin:Exchange Now:read"],"tags":["Trade"],"description":"Get the current FX rate for a currency pair and receive a short-lived\t vfx_token for creating an FX trade.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxRateRq"}}}},"responses":{"200":{"description":"Successfully get the fx rates of given currency pair","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxRateRs"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get FX rate (deprecated)"}},"/fx/quote":{"post":{"operationId":"client_get_fx_quote","x-atlas-api":true,"x-permission-config":["Client:At Verto Rate:read","Admin:Exchange Now:read"],"tags":["Trade"],"description":"Get the current FX rate for a currency pair and receive a short-lived\t vfx_token for creating an FX trade.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxQuoteRq"}}}},"responses":{"200":{"description":"Successfully get the fx rates of given currency pair","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxRateRs"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get FX quote"}},"/fx/bulk-rate":{"post":{"operationId":"client_get_fx_bulk_rate","x-atlas-api":true,"x-permission-config":["Client:At Verto Rate:read","Admin:Exchange Now:read"],"tags":["Trade"],"description":"Get exchange rates for multiple currency pairs in one bulk FX rate request.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxBulkRateRq"}}}},"responses":{"200":{"description":"Successfully get the fx rates of given multiple currency pairs","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Success status of api"},"exchangeRateRes":{"type":"array","description":"list of exchange rates of given currency pairs","items":{"$ref":"#/components/schemas/FxRateForClient"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get bulk FX rates"}},"/fx/payments":{"post":{"operationId":"client_make_payment","x-atlas-api":true,"x-permission-config":["Client:At Verto Rate:write","Admin:Exchange Now:write"],"tags":["Trade"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRq"}}}},"responses":{"200":{"description":"payment request success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRs"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Create FX trade","description":"Create an FX trade to convert wallet funds and either pay out to a beneficiary or move funds into another wallet."}},"/fx/list":{"post":{"operationId":"client_list_fx_orders","x-atlas-api":true,"x-permission-config":["Client:At Verto Rate:read","Client:Basic Access:read","Admin:Exchange Now:read","Client:Transaction History:read","Admin:Transactions:read"],"tags":["Trade"],"parameters":[{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/skipParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"createdStartDate":{"allOf":[{"$ref":"#/components/schemas/Date"},{"description":"start date for filtering the list."}]},"createdEndDate":{"allOf":[{"$ref":"#/components/schemas/Date"},{"description":"end date for filtering the list."}]},"scheduledStartDate":{"allOf":[{"$ref":"#/components/schemas/Date"},{"description":"scheduled start date for filtering the list."}]},"scheduledEndDate":{"allOf":[{"$ref":"#/components/schemas/Date"},{"description":"scheduled end date for filtering the list."}]},"fromCurrencies":{"type":"array","items":{"$ref":"#/components/schemas/ECurrency"},"description":"specify the source currency list for fx orders.","example":["USD","AED"]},"toCurrencies":{"type":"array","items":{"$ref":"#/components/schemas/ECurrency"},"description":"specify the target currency list for fx orders.","example":["GBP","AUD"]},"sources":{"type":"array","items":{"$ref":"#/components/schemas/EFinancialEntityType"},"description":"specify the sources for filtering the list."},"targets":{"type":"array","items":{"$ref":"#/components/schemas/EFinancialEntityType"},"description":"specify the targets for filtering the list."},"sourceTargetPairs":{"type":"array","items":{"type":"object","required":["source","target"],"properties":{"source":{"$ref":"#/components/schemas/EFinancialEntityType"},"target":{"$ref":"#/components/schemas/EFinancialEntityType"}}}},"minimumAmount":{"type":"number","description":"specify the minimum amount from for filtering the list."},"maximumAmount":{"type":"number","description":"specify the maximum amount from for filtering the list."},"search":{"type":"string","minLength":1,"maxLength":50,"description":"search the records.","example":"EN-01011900-001"},"state":{"type":"object","properties":{"include":{"type":"array","items":{"$ref":"#/components/schemas/EOrderState"}},"exclude":{"type":"array","items":{"$ref":"#/components/schemas/EOrderState"}}}},"paymentIds":{"type":"array","example":["807e02f5-7235-4826-aef5-d93c75216b48","807e02f5-7235-4826-aef5-d93c75216b48"],"items":{"type":"string"}},"companyIds":{"type":"string","example":["2453","2234"],"items":{"type":"string"}},"userId":{"type":"string","nullable":true,"description":"filter orders by specific user record ID (admin only).","example":"12345"},"beneficiaryReferences":{"type":"array","items":{"type":"string"},"description":"filter orders by counterparty (beneficiary) reference(s), scoped to your company.","example":["RP-1A2B3C","RP-4D5E6F"]},"referenceSearchQuery":{"type":"string","minLength":1,"maxLength":50,"description":"exact-match search by the Verto transaction reference or your custom/payment reference.","example":"EN-01011900-001"}}}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientOrderListResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List FX trades","description":"List FX trades for your company with pagination and optional filters for trade state, date range, source and target type, and payment IDs."}},"/fx/markup/config":{"post":{"operationId":"client_set_fx_markup_config","x-atlas-api":true,"x-permission-config":["Client:At Verto Rate:write","Admin:Exchange Now:write"],"tags":["Trade"],"description":"Set a universal or currency-pair FX markup percentage for a company.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetFxMarkupConfigRq"}}}},"responses":{"200":{"description":"Successfully set FX markup configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessRes"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Set FX markup configuration"},"get":{"operationId":"client_get_fx_markup_config","x-atlas-api":true,"x-permission-config":["Client:At Verto Rate:read","Admin:Exchange Now:read"],"tags":["Trade"],"description":"Retrieve FX markup configurations for a company, optionally filtered by\tmarkup type or currency pair.","parameters":[{"$ref":"#/components/parameters/currencyFromParam"},{"$ref":"#/components/parameters/currencyToParam"},{"$ref":"#/components/parameters/markupTypeParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/skipParam"}],"responses":{"200":{"description":"Successfully retrieved FX markup configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxMarkupConfigRs"}}}}},"summary":"Get FX markup configuration"}}},"components":{"parameters":{"referenceParam":{"name":"reference","in":"path","description":"Identifier of the FX order. You can use either of the following, whichever you have to hand:\n* **Verto reference** - the `reference` returned to you when the order was created, e.g. `EN-01011900-001` or `AX-01011900-001` for an FX order.\n* **Your `paymentId`** - the idempotency key (UUID) you sent in the body of the create order request. Use this to look up an order without having to store the Verto reference.","required":true,"schema":{"type":"string"},"examples":{"orderReference":{"summary":"FX order reference","value":"EN-01011900-001 or AX-01011900-001"},"paymentId":{"summary":"paymentId sent in the create order request","value":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}},"limitParam":{"name":"limit","in":"query","description":"max records to return","required":true,"schema":{"type":"integer","format":"int32"}},"skipParam":{"name":"skip","in":"query","description":"number of items to skip","required":true,"schema":{"type":"integer","format":"int32"}},"currencyFromParam":{"name":"currencyFrom","in":"query","description":"Source currency code for filtering FX markup configurations","required":false,"schema":{"$ref":"#/components/schemas/Currency"},"example":"USD"},"currencyToParam":{"name":"currencyTo","in":"query","description":"Target currency code for filtering FX markup configurations","required":false,"schema":{"$ref":"#/components/schemas/Currency"},"example":"EUR"},"markupTypeParam":{"name":"markupType","in":"query","description":"Type of markup configuration for filtering","required":false,"schema":{"$ref":"#/components/schemas/FxMarkupType"},"example":"currency_pair"}},"schemas":{"ClientOrderResponse":{"type":"object","properties":{"id":{"type":"string","description":"unique id of order","example":1},"userId":{"type":"number","description":"unique id of user who created the order","example":2},"currencyFrom":{"allOf":[{"$ref":"#/components/schemas/ECurrency"},{"description":"source currency code for currency exchange."},{"example":"USD"}]},"amountFrom":{"allOf":[{"$ref":"#/components/schemas/Amount"},{"description":"source amount to be exchanged."},{"example":100}]},"currencyTo":{"allOf":[{"$ref":"#/components/schemas/ECurrency"},{"description":"target currency code for currency exchange."},{"example":"GBP"}]},"amountTo":{"allOf":[{"$ref":"#/components/schemas/Amount"},{"description":"converted amount in the target currency."},{"example":99.7}]},"rate":{"type":"number","description":"exchange rate between the source and target currencies.","example":0.997},"pricing":{"$ref":"#/components/schemas/Pricing"},"state":{"$ref":"#/components/schemas/EOrderState"},"source":{"$ref":"#/components/schemas/EOrderSource"},"sourceId":{"type":"number","description":"unique id of source","example":3},"target":{"$ref":"#/components/schemas/EOrderTarget"},"targetId":{"type":"number","description":"unique id of target.","example":3},"tracking":{"$ref":"#/components/schemas/PaymentTracking"},"transaction":{"$ref":"#/components/schemas/TransactionDetails"},"reference":{"type":"string","description":"unique reference of order.","example":"EN-01011900-001"},"depositAccountId":{"type":"number","description":"unique id of deposit account.","example":5},"description":{"$ref":"#/components/schemas/ClientDescription"},"inwardSettlementTime":{"$ref":"#/components/schemas/Date"},"outwardSettlementTime":{"$ref":"#/components/schemas/Date"},"purpose":{"$ref":"#/components/schemas/EPurpose"},"isArchived":{"type":"boolean","description":"is order archived.","example":false},"scheduledAt":{"$ref":"#/components/schemas/Date"},"expiredAt":{"$ref":"#/components/schemas/Date"},"createdAt":{"$ref":"#/components/schemas/Date"},"updatedAt":{"$ref":"#/components/schemas/Date"},"estimatedTimeInHoursToReflect":{"type":"integer","minimum":0,"nullable":true,"description":"Estimated whole hours (non-negative integer) for funds to reflect in the target account or wallet."},"OrderSources":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderSourcesItem"}}}},"supportingDocument":{"type":"string","description":"Pre-signed document URL which client has attached with the order.","example":"https://s3.amazonaws.com/bucket-name/document.pdf"},"supportingDocuments":{"type":"array","description":"Pre-signed URLs for all supporting documents associated with the order. Only present when one or more documents exist.","items":{"type":"string","example":"https://s3.amazonaws.com/bucket-name/document.pdf"}}}},"FxRateRq":{"type":"object","required":["currencyFrom","currencyTo"],"properties":{"amountCurrency":{"allOf":[{"$ref":"#/components/schemas/Currency"},{"description":"The amount currency e.g. GBP"},{"example":"GBP"}]},"amount":{"allOf":[{"$ref":"#/components/schemas/Amount"},{"description":"Amount to be exchanged with up to two decimal places."},{"example":6543423.45},{"minimum":0},{"multipleOf":0.01}]},"paymentMode":{"type":"string","nullable":true,"enum":["immediate","later"],"default":"immediate"},"currencyFrom":{"description":"source currency","allOf":[{"$ref":"#/components/schemas/CurrencyShort"}]},"currencyTo":{"description":"destination currency","allOf":[{"$ref":"#/components/schemas/CurrencyShort"}]}}},"FxRateRs":{"allOf":[{"$ref":"#/components/schemas/FxRate"},{"type":"object","properties":{"success":{"type":"boolean","example":true}}}]},"FxQuoteRq":{"type":"object","required":["amount","amountCurrency","currencyFrom","currencyTo"],"properties":{"paymentMode":{"type":"string","nullable":true,"enum":["immediate","later"],"default":"immediate"},"currencyFrom":{"description":"source currency","example":"GBP","allOf":[{"$ref":"#/components/schemas/Currency"}]},"currencyTo":{"description":"destination currency","example":"USD","allOf":[{"$ref":"#/components/schemas/Currency"}]},"amountCurrency":{"allOf":[{"$ref":"#/components/schemas/Currency"},{"description":"The amount currency e.g. GBP"},{"example":"GBP"}]},"amount":{"allOf":[{"$ref":"#/components/schemas/Amount"},{"description":"Amount to be exchanged with up to two decimal places. Must be greater than zero."},{"example":6543423.45},{"minimum":0.01},{"multipleOf":0.01}]}}},"FxBulkRateRq":{"type":"object","required":["currencyPairs"],"properties":{"paymentMode":{"type":"string","nullable":true,"enum":["immediate","later"],"default":"immediate"},"currencyPairs":{"type":"array","description":"Array of currency pairs for bulk rate request","items":{"$ref":"#/components/schemas/CurrencyPair"}}}},"FxRateForClient":{"properties":{"rate":{"type":"string","description":"exchange rate"},"currencyFrom":{"allOf":[{"$ref":"#/components/schemas/Currency"},{"description":"source currency"},{"example":"USD"}]},"currencyTo":{"allOf":[{"$ref":"#/components/schemas/Currency"},{"description":"destination currency"},{"example":"GBP"}]}}},"PaymentRq":{"type":"object","description":"Two request shapes are available, selected by `paymentType`. Use the selector above the schema to switch between them.","oneOf":[{"$ref":"#/components/schemas/ConvertWithinWalletsParams"},{"$ref":"#/components/schemas/ConvertWalletPayoutParams"}],"discriminator":{"propertyName":"paymentType","mapping":{"convertWithinWallets":"#/components/schemas/ConvertWithinWalletsParams","convertWalletPayout":"#/components/schemas/ConvertWalletPayoutParams"}}},"PaymentRs":{"type":"object","$ref":"#/components/schemas/ClientOrderResponse"},"Date":{"type":"string","format":"date-time"},"ECurrency":{"type":"string","minLength":3,"maxLength":3,"enum":["USD","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SPL","SRD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TVD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMW","ZWD"]},"EFinancialEntityType":{"type":"string","enum":["account","wallet"]},"EOrderState":{"type":"string","enum":["initiated","confirmed","inwardSettlementDone","outwardSettlementDone","archived"],"description":"current state of the exchange process."},"ClientOrderListResponse":{"allOf":[{"$ref":"#/components/schemas/PagingInfoResponse"}],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ClientOrderResponse"}}}},"SetFxMarkupConfigRq":{"type":"object","required":["markupPerc","markupType"],"properties":{"markupPerc":{"type":"number","description":"markup percentage for a company","example":2.5,"minimum":0,"maximum":10},"currencyTo":{"$ref":"#/components/schemas/Currency"},"currencyFrom":{"$ref":"#/components/schemas/Currency"},"markupType":{"type":"string","$ref":"#/components/schemas/FxMarkupType"}}},"SuccessRes":{"type":"object","properties":{"success":{"type":"boolean","example":true}}},"FxMarkupConfigRs":{"type":"object","required":["totalCount","items","statusCode"],"properties":{"totalCount":{"type":"number","description":"Total number of FX markup configurations","example":1},"items":{"type":"array","description":"Array of FX markup configurations","items":{"$ref":"#/components/schemas/FxMarkupConfig"}},"statusCode":{"type":"integer","description":"HTTP status code","example":200}}},"Currency":{"type":"string","minLength":3,"maxLength":3,"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SPL","SRD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TVD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMW","ZWD"]},"FxMarkupType":{"type":"string","enum":["sub_client","partner_refereel","currency_pair","universal"],"description":"Type of FX markup configuration"},"Amount":{"type":"number","format":"float"},"Pricing":{"type":"object","properties":{"overageFee":{"allOf":[{"$ref":"#/components/schemas/Amount"},{"description":"additional fee applied for exceeding specified limits."},{"example":10}]},"usageId":{"$ref":"#/components/schemas/Uuid"},"subscriptionId":{"$ref":"#/components/schemas/Uuid"}}},"EOrderSource":{"allOf":[{"$ref":"#/components/schemas/EFinancialEntityType"},{"description":"the origin, which can be either a wallet or an account from which money will be deducted."},{"example":"wallet"}]},"EOrderTarget":{"allOf":[{"$ref":"#/components/schemas/EFinancialEntityType"},{"description":"the recipient, which can be either a wallet or an account where the money will be deposited."},{"example":"account"}]},"PaymentTracking":{"type":"object","properties":{"mt103":{"type":"string","example":":71A:HDFC\\n:72:SB\\n:77B:John Doe"},"uetr":{"type":"string","example":"dd60300f-25e6-4fb3-bb87-36ceb02844f2"}}},"TransactionDetails":{"type":"object","description":"contains receiver bank account details","properties":{"receiver":{"type":"object","properties":{"accountNumber":{"type":"string","description":"bank account number.","example":"20000999"},"name":{"type":"string","description":"bank account name.","example":"John Doe"},"bankName":{"type":"string","description":"bank name","example":"HDFC"},"bankCode":{"type":"string","description":"bank account code.","example":"HDFCINBBPNE"}}}}},"ClientDescription":{"type":"string","description":"custom description of order entered by customer.","example":"USD to GBP conversion.","nullable":true},"EPurpose":{"type":"string","enum":["Purchase of Good(s)","Purchase of Professional Service(s)","Professional fees payment(i.e. legal, accountant)","Payroll/Personnel Payment","Payment for a loan or deposit","Bill payment(i.e. credit card, utility)","Research and Development","Payment, Family Assistance","Medical Assistance","Medical Claim Reimbursement","Remittance of funds from e-commerce","IP Trademark Patent Work","Travel/Hospitality","Publisher","Investment","Wallet Top Up","Internal Company Transfer"],"description":"Purpose for currency exchange"},"OrderSourcesItem":{"type":"object","properties":{"id":{"type":"number","example":1},"reference":{"type":"string","example":"EN10122025-001"},"entityType":{"type":"string","example":"wallet"},"entityId":{"type":"number","example":3134}}},"CurrencyShort":{"type":"object","properties":{"id":{"description":"currency id","type":"number","example":1},"currencyName":{"$ref":"#/components/schemas/Currency"}}},"FxRate":{"properties":{"rate":{"type":"string"},"vfx_token":{"type":"string"},"expiry":{"type":"string"}}},"CurrencyPair":{"type":"object","properties":{"currencyFrom":{"allOf":[{"$ref":"#/components/schemas/Currency"},{"example":"USD"}]},"currencyTo":{"allOf":[{"$ref":"#/components/schemas/Currency"},{"example":"GBP"}]}}},"ConvertWithinWalletsParams":{"title":"Convert within your own wallets","type":"object","required":["paymentType","targetWalletId","vfxToken"],"properties":{"paymentType":{"description":"Selects the flow. `convertWithinWallets` converts between two of your own wallets; `convertWalletPayout` converts and pays the proceeds out to a beneficiary.","enum":["convertWithinWallets"]},"sourceWalletId":{"description":"Wallet the funds are converted from. Use this with `sourceAmount` for a single funding wallet, or use `sources` to fund from several.","type":"number"},"sources":{"description":"Fund the conversion from more than one wallet. Each entry gives a `walletId` and the `amount` to draw from it. Use instead of `sourceWalletId` / `sourceAmount`.","type":"array","items":{"$ref":"#/components/schemas/OrderFundingSource"}},"sourceAmount":{"description":"Amount to sell, in the source currency. Send either `sourceAmount` or `targetAmount` — whichever side of the trade is fixed.","type":"number"},"targetAmount":{"description":"Amount to buy, in the target currency. Send either `sourceAmount` or `targetAmount` — whichever side of the trade is fixed.","type":"number"},"targetWalletId":{"description":"Wallet that receives the converted funds.","type":"number"},"customPaymentReference":{"description":"Your own reference for this trade. Stored and returned on the trade, not used for de-duplication.","type":"string","nullable":true},"purposeId":{"type":"number","nullable":true,"description":"Mandatory for APIKey login, if they are adding supportingDocS3Key."},"supportingDocS3Key":{"description":"Key of a supporting document previously uploaded through the upload-link endpoint.","type":"string","nullable":true},"vfxToken":{"type":"string","description":"Quote token returned by Get FX rate or Get FX quote. It locks the rate for this trade and expires with the quote."},"paymentId":{"allOf":[{"$ref":"#/components/schemas/Uuid"}],"nullable":true,"description":"Mandatory for APIKey login, helps identify a unique payment request. If the same value is sent in a duplicate payment request, it will be rejected."},"fxMarkup":{"description":"Markup to apply to this trade, as either a `percentage` or a `rate`. Overrides your configured default markup.","type":"object","$ref":"#/components/schemas/fxMarkup"},"estimatedTimeInHoursToReflect":{"type":"integer","minimum":0,"nullable":true,"description":"Estimated whole hours (non-negative integer) for funds to reflect in the target account."}}},"ConvertWalletPayoutParams":{"title":"Convert and pay out to a beneficiary","type":"object","required":["paymentType","targetAccountId","vfxToken","purposeId"],"properties":{"paymentType":{"description":"Selects the flow. `convertWithinWallets` converts between two of your own wallets; `convertWalletPayout` converts and pays the proceeds out to a beneficiary.","enum":["convertWalletPayout"]},"sourceWalletId":{"description":"Wallet the funds are converted from. Use this with `sourceAmount` for a single funding wallet, or use `sources` to fund from several.","type":"number"},"sources":{"description":"Fund the conversion from more than one wallet. Each entry gives a `walletId` and the `amount` to draw from it. Use instead of `sourceWalletId` / `sourceAmount`.","type":"array","items":{"$ref":"#/components/schemas/OrderFundingSource"}},"sourceAmount":{"description":"Amount to sell, in the source currency. Send either `sourceAmount` or `targetAmount` — whichever side of the trade is fixed.","type":"number"},"targetAmount":{"description":"Amount to buy, in the target currency. Send either `sourceAmount` or `targetAmount` — whichever side of the trade is fixed.","type":"number"},"targetAccountId":{"description":"Beneficiary account that receives the payout.","type":"number"},"vfxToken":{"description":"Quote token returned by Get FX rate or Get FX quote. It locks the rate for this trade and expires with the quote.","type":"string"},"usageToken":{"type":"string"},"purposeId":{"description":"Purpose of payment for the payout leg. Use one of the codes returned by the purpose codes endpoint; required values vary by destination market.","type":"number"},"supportingDocS3Key":{"description":"Key of a supporting document previously uploaded through the upload-link endpoint.","type":"string","nullable":true},"supportingDocS3Keys":{"type":"array","nullable":true,"items":{"type":"string"}},"customPaymentReference":{"description":"Your own reference for this trade. Stored and returned on the trade, not used for de-duplication.","type":"string","nullable":true},"paymentId":{"allOf":[{"$ref":"#/components/schemas/Uuid"}],"nullable":true,"description":"Mandatory for APIKey login, helps identify a unique payment request. If the same value is sent in a duplicate payment request, it will be rejected."},"sender":{"description":"Identity of the underlying customer a payout is made on behalf of. Required when a fintech or financial institution pays out from a master wallet; not required for platform sub-account payouts or for your own corporate payments.","type":"object","nullable":true,"properties":{"country":{"type":"string","nullable":true,"example":"UK"},"type":{"type":"string","nullable":true,"enum":["individual","company"]},"name":{"type":"string","nullable":true,"example":"John Doe"},"dob":{"type":"string","format":"date","nullable":true,"example":"1980-05-30"}}},"fxMarkup":{"description":"Markup to apply to this trade, as either a `percentage` or a `rate`. Overrides your configured default markup.","type":"object","$ref":"#/components/schemas/fxMarkup"},"estimatedTimeInHoursToReflect":{"type":"integer","minimum":0,"nullable":true,"description":"Estimated whole hours (non-negative integer) for funds to reflect in the target account or wallet."}}},"PagingInfoResponse":{"type":"object","properties":{"totalCount":{"type":"number","description":"total count of items in database","example":90},"currentPage":{"type":"number","description":"current page index in pagination.","example":1},"pageSize":{"type":"number","description":"number items to be fetched at once.","example":10}}},"FxMarkupConfig":{"type":"object","required":["_id","companyId","markupType","markupPerc","isActive"],"properties":{"_id":{"type":"string","description":"Unique identifier for the markup config","example":"507f1f77bcf86cd799439011"},"companyId":{"type":"string","description":"Company identifier","example":"3046"},"markupType":{"$ref":"#/components/schemas/FxMarkupType"},"markupPerc":{"type":"number","format":"double","description":"Markup percentage","example":1.5},"currencyFrom":{"type":"string","description":"Source currency code (ISO 4217)","pattern":"^[A-Z]{3}$","example":"USD"},"currencyTo":{"type":"string","description":"Target currency code (ISO 4217)","pattern":"^[A-Z]{3}$","example":"EUR"},"subAccountId":{"type":"string","description":"Sub-account identifier (optional)","nullable":true},"isActive":{"type":"boolean","description":"Whether the configuration is active","example":true},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp","example":"2024-08-04T10:30:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp","example":"2024-08-04T10:30:00Z"}}},"Uuid":{"type":"string","minLength":1,"maxLength":50,"example":"550e8400-e29b-41d4-a716-446655440000"},"OrderFundingSource":{"type":"object","required":["walletId","amount"],"properties":{"walletId":{"type":"number"},"amount":{"type":"number"}}},"fxMarkup":{"type":"object","properties":{"percentage":{"type":"number","format":"float","description":"value of the fx markup in percentage","example":0.5,"minimum":0,"maximum":10},"rate":{"type":"number","format":"float","description":"fx markup rate to be applied on the exchange rate for currency exchange.","example":0.005}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"example":{"message":"Bad Request"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"example":{"message":"Unauthorized"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"example":{"message":"Forbidden"}}}},"ServerError":{"description":"Internal Server Error","content":{"application/json":{"example":{"message":"Internal Server Error"}}}}}},"security":[],"servers":[{"url":"https://api-exchange-now-beta.vertofx.com"},{"url":"https://api-exchange-now-sandbox.vertofx.com"}]}