MultiCurrency Wallets

Get Quote to Transfer between multicurrency wallets.

post/v0.2.4/multicurrency-wallets/transfer/quote

Request

Base URL
https://api.chimoney.io
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/chimoney/apis/chimoney-api-docs/docs/v0.2.4/multicurrency-wallets/transfer/quote/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

senderstring

ID of Multicurrency Account. Leave blank to transfer from parent.

amountToSendstring required

Amount in originCurrency currency to transfer/swap.

originCurrencystring required

ISO Currency String like CAD, USD etc of the wallet to transfer from.

destinationCurrencystring required

ISO Currency String like CAD, USD etc of the wallet to transfer to.

receiverstring

Receiver's Multicurrency Account ID.

emailstring

Receiver's email.

phoneNumberstring

Receiver's phone number.

Example request

{
  "sender": "907b90ef-d723-4b07-9f74-480afb5f09ef",
  "amountToSend": "20",
  "originCurrency": "USD",
  "destinationCurrency": "USD",
  "receiver": "0c136fa6-84bc-49f0-a767-0804c1fd33f6",
  "email": "ogedifavour2@gmail.com",
  "phoneNumber": "+16471234567"
}

Response

Success.

statusstring

messagestring

Example response

{
  "status": "success",
  "message": "Quote generated successfully",
  "data": {
    "receiver": "0c136fa6-84bc-49f0-a767-0804c1fd33f6",
    "sender": "907b90ef-d723-4b07-9f74-480afb5f09ef",
    "originCurrency": "USD",
    "originCurrencyDebitAmount": "20",
    "destinationCurrency": "USD",
    "destinationCurrencyCreditAmount": "20",
    "markups": {}
  }
}

Changes

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