15. Money Transfer (Wallet - Alias)

You can use this service to perform money transfers between wallets.

Money Transfer from Wallet Id to Wallet Alias

POST{{WalletUrl}}/api/v1/wallet/transfer/by/wallet/to/alias

circle-info

Note: To use this service, it is mandatory to include the apikeypublic and apiclientpublic parameters in the Header field.

WalletAPI Address

The parameters that need to be sent to the service are as follows:

Parameter
Type
Compulsory
Description

apikeypublic

string

Yes

The public key used for API access.

apiclientpublic

string

Yes

The public key used to identify the client.

{
  "SourceWalletId": "7883fb19-2359-4a9b-b917-f08a259898ed",
  "DestinationAlias": "8460440228",
  "Amount": 1,
  "Description": "string",
  "ExternalReference": "{{$guid}}"
}

Service Request

Parameter
Type
Description

SourceWalletId

Guid

The identity information of the account from which the money will be withdrawn.

DestinationAlias

string

The account number to which the money will be transferred.

Amount

decimal

The amount to be transferred.

Description

string

The description of the relevant transaction.

Service Request

Parameter
Type
Description

IsFailure

bool

It returns true if the service transaction failed, otherwise false.

IsSuccess

bool

It returns true if the service transaction was successful, otherwise false.

Errors

Array

Contains the error messages encountered during the transaction.

Value

Array<Items>

The successful data set returned from the service.

Service Request (Value)

Parameter
Type
Description

TransferId

Guid

Transfer transaction identifier information

SourceTransactionId

Guid

Identifier information of the transaction generated for the source wallet account

DestinationTransactionId

Guid

Identifier information of the transaction generated for the recipient wallet account

SourceWalletId

Guid

Source wallet identifier information

DestinationWalletId

Guid

Recipient wallet identifier information

SourceWalletBalanceAfterTransaction

decimal

Source wallet balance after the transaction

DestinationWalletBalanceAfterTransaction

decimal

Recipient wallet balance after the transaction

Last updated