MoneyTransfer API

The OrderPurchase method validates a request for a transaction, by verifying that the vendor key and the end user details are valid. If so, the method returns a token representing the transaction. The end user is not charged when OrderPurchase is called; he or she is charged only after performing the final approval of the transaction.

Pay attention
Before calling the Cellarix API, the business client must obtain a vendor identification key, generated by Cellarix. This key must be passed with each API call. The format of the key is:
<Key> <KeyObj> <PhoneNumber>Supplier phone number</PhoneNumber> <SecureKey>Secure key from Cellarix</SecureKey> </KeyObj> </Key>

Input Parameters
m-Mandatory fields
Parameter Type Description
(m) sKey string The business client’s vendor identification key.
(m) Amount int The amount that will be transfered to the recipient.
(m) PhoneNumberRecipient string The phone number of the recipient.
Message string A message that will be sent to the recipient.
SupplierDealId string Optional. A unique ID, generated by the client application, which identifies the transaction.
(m) ServiceId int The numeric ID of the vendor service. This value is useful for differentiating between several consumer services offered by the same business client. After registration, the business client must request Cellarix to allocate the number of service IDs that it needs.
IsAmountChangable bool Whether to allow the end user to change the amount. False by default.
ImageLogoUrl string URL of the supplier logo, which is displayed on the Cellarix page.
MobileImageLogoUrl string URL of the supplier logo, which is displayed on the Cellarix mobile page.
(m) SupplierRedirectPage string The page to which the end user is redirected at the end of the payment process.
SupplierURL string The URL that the Cellarix server will call when the end user approves the transaction, supplying details about the transaction. See SupplierURL Callback Method for more details.
UserDetails\PhoneNumber string The end user’s phone number.
UserDetails\Email string The end user’s email address.
UserDetails\UserFirstName string The end user’s first name.
UserDetails\UserLastName string The end user’s last name.
UserDetails\UserIdNumber string The end user’s ID number.
OrderTokenDurationInMinutes int The number of minutes until the Order Token will expire.
Output Parameters
Parameter Type Description
Status\Number string A numeric value indicating success or failure of the call.
1 indicates success. A negative value indicates failure.
See Appendix: Cellarix API Error Codes for more details about error codes.
Status\Message string A textual description of the call’s status (an error message in case of failure).