Transfer Funds
This transaction is used to transfer funds from one account to another. For now only checking to checking transfers are allowed.
Field Name | Len | Type | Req | Ver | Comments |
method | N/A | Alp-Num | Yes | 1.0 | transferFunds |
fromEmail | N/A | Alp-Num | Yes | 1.0 | The email associated with the account from which the amount is deducted |
toEmail | N/A | Alp-Num | Yes | 1.0 | The email associated with the account where the amount is transfered to |
amount | N/A | Real | Yes | 1.0 | The amount to be transfered |
currency | 3 | Alp | Yes | 1.0 | the currency code (e.g. USD) |
firstName | N/A | Alp | -- | 1.1 | If first name is sent within the request, the transfer will be processed only if first name on file maches the provided first name |
lastName | N/A | Alp | -- | 1.1 | If last name is sent within the request, the transfer will be processed only if last name on file maches the provided last name |
businessName | N/A | Alp-Num | -- | 1.1 | Aplies only if money is sent to business accounts. If business name is sent within the request, the transfer will be processed only if business name on file maches the provided business name |
reference | N/A | Alp-Num | -- | 1.1 | You can send a reference for your internal accounting |
note | N/A | Alp-Num | -- | 1.0 | The transaction note |
subscriptionFrequency | 1 | Num | -- | 1.1 | The frequency of periodical transfer
1 = Every Week 2 = Every TwoWeeks 3 = Every Month 4 = Every Three Months 5 = Every Six Months 6 = Annualy |
subscriptionEndDate | N/A | Alp-Num | -- | 1.1 | A date or null |
subscriptionUserCancel | N/A | Alp-Num | -- | 1.1 | 1 = user cancel this subscription, or null |
subscriptionTransactions | N/A | Alp-Num | -- | 1.1 | Number = the subscription will end after the transactions, or null |
key | N/A | Alp-Num | Yes | 1.0 | MD5(sharedSecret + toEmail + amount + currency + *note + *firstName + *lastName + *businessName + *reference + *subscriptionFrequency + *subscriptionEndDate + *subscriptionUserCancel + *subscriptionTransactions) (*if optional variables are missing, they should be left out of the key construction) |
This request is responded by a message with the following content:
Field Name | Len | Type | Mdt | Ver | Comments |
ResponseCode | N/A | Alp-Num | Yes | 1.0 | The response code; 00 = Success; |
ResponseDescription | N/A | Alp-Num | Yes | 1.0 | Human readable response |
Fee | N/A | Real | Yes | 1.0 | Fee for the current transaction |
TransactionId | N/A | Num | Yes | 1.0 | The transaction ID if successfully, otherwise not specified |
https://secure.paxum.com/payment/api/paymentAPI.php POST method=transferFunds&fromEmail=payer%40domain.com&toEmail=payee%40domain.com&amount=20.00¤cy=USD&firstName=fistName&lastName=lastName&businessName=businessName¬e=transaction+note&key=1816aa07ce3b2fba46f794ab95b9699a
Response Sample:
<?xml version="1.0"?> <Response> <Environment>PRODUCTION</Environment> <Method>transferFunds</Method> <ResponseCode>00</ResponseCode> <ResponseDescription>Approved or Completed Successfully</ResponseDescription > <Fee>0.00</Fee> <TransactionId>23646236</TransactionId> </Response>
Working Sample(s):
transferFunds.php