Sign in

v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
MultiCurrency Wallets
Interledger

Transfer from multicurrency wallet to another wallet, an email or a phone number.

post/v0.2.4/multicurrency-wallets/transfer

Request body

senderstring

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

subAccountstring

ID of Sub/Multicurrency Account. Overrides sender.

amountToSendstring required

Amount in originCurrency currency to transfer/swap.

originCurrencystring required

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

receiverstring

Valid Chimoney Multi-currency Account, User or Organization ID.

emailstring

Send transfer to an email. Ignored if receiver is valid

phoneNumberstring

Send transfer to a phone number. Ignored if receiver or email is valid

destinationCurrencystring required

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

narrationstring

Narration/Description of the payment to be included in the notification to the user.

turnOffNotificationboolean

Disables email and other notifications from Chimoney.

sendViaInterledgerboolean

Instructs the transaction to be sent via Interledger. Sender is required to have a valid originCurrency payment Pointer and Receiver is required to have a valid destinationCurrency payment pointer.

Example request

{
  "subAccount": "82628206-0253-4d37-b919-569efe896506",
  "amountToSend": "2",
  "originCurrency": "USD",
  "receiver": "1234567",
  "email": "user@mail.com",
  "phoneNumber": "+16471234567",
  "destinationCurrency": "USD",
  "narration": "Cross wallet transfer",
  "sendViaInterledger": true
}

Response

Success.

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "Payout to Chimoney wallets completed successfully.",
  "data": {
    "paymentLink": "http://localhost:4000/pay/?issueID=82628206-0253-4d37-b919-569efe896506_2_1725919202472",
    "data": [
      {
        "id": "RnNDSRhA9xzTe9qSiBfb",
        "valueInUSD": "2",
        "chimoney": 2000,
        "issueID": "82628206-0253-4d37-b919-569efe896506_2_1725919202472",
        "receiver": "ae07bf52-002b-489a-bc12-202f3beb3260",
        "personalizedMessage": "Cross wallet transfer",
        "fee": 1,
        "type": "chimoney",
        "issuer": "82628206-0253-4d37-b919-569efe896506",
        "t_id": 633011,
        "chiRef": "3f4ca4f3-7bd7-44d0-bc8f-089bd9052b5e",
        "narration": "Cross wallet transfer",
        "integration": {
          "appID": "TyGlLVepVqfOj3635qrC"
        },
        "issueDate": "2024-09-09T22:00:18.901Z",
        "redeemLink": "http://localhost:4000/redeem/?chi=3f4ca4f3-7bd7-44d0-bc8f-089bd9052b5e"
      }
    ]
  }
}