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

post https://api.chimoney.io/v0.2.4/multicurrency-wallets/transfer

Body Params

sender

string

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

subAccount

string

ID of Sub/Multicurrency Account. Overrides sender.

amountToSend

string

required

Amount in originCurrency currency to transfer/swap.

originCurrency

string

required

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

receiver

string

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

string

Send transfer to an email. Ignored if receiver is valid

phoneNumber

string

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

destinationCurrency

string

required

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

narration

string

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

turnOffNotification

boolean

Disables email and other notifications from Chimoney.

sendViaInterledger

boolean

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.

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.chimoney.io/v0.2.4/multicurrency-wallets/transfer \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

400Validation error in the request.

401Access to this resource is not available for unauthenticated users.

403Access to this resource is forbidden.

500Indicates an internal server error.