Add Bank Account
Add Bank Account
Field Name | Len | Type | Req | Ver | Comments |
method | N/A | Alp-Num | Yes | 1.1 | addBankAccount |
fromEmail | N/A | Alp-Num | Yes | 1.1 | The email associated with the account from which the amount is deducted |
firstName | N/A | Alp | Yes | 1.1 | First Name + Middle Name |
lastName | N/A | Alp | Yes | 1.1 | Last Name |
companyName | N/A | Alp-Num | -- | 1.1 | You must complete this field only if this bank account belong to your company |
phone | 10 | Num | Yes | 1.1 | Phone Number (digits only) |
addressId | N/A | Alp-Num | Yes | 1.1 | Address Id |
bankName | N/A | Alp | Yes | 1.1 | Holder's Bank Name |
bankSwiftCode | N/A | Alp-Num | -- | 1.1 | Holder's Bank SWIFT Code |
bankStreet | N/A | Alp-Num | Yes | 1.1 | Holder's Bank Street |
bankCity | N/A | Alp | Yes | 1.1 | Holder's Bank City |
bankState | 2 / 3 | Alp | Yes | 1.1 | Holder's Bank State two - three letters state / province / county code (ISO 3166-2) |
bankCountry | 2 | Alp | Yes | 1.1 | Holder's Bank Country two letters country code (ISO Char 2 Code) |
bankPostalCode | N/A | Alp-Num | Yes | 1.1 | Holder's Bank Zip / Postal Code |
bankAccountNumber | N/A | Alp-Num | Yes | 1.1 | Holder's Bank Account Number |
currency | 3 | Alp | Yes | 1.1 | Holder's Bank Account Currency (e.g. USD) |
bankRoutingCode | N/A | Alp-Num | -- | 1.1 | Holder's Bank Routing Code |
bankAccountType | 1 | Num | Yes | 1.1 | Account Type
1 = Checking 2 = Savings |
accountType | 1 | Num | Yes | 1.1 | label.field.accountType
1 = Primary 2 = Secondary |
intermediaryName | N/A | Alp | -- | 1.1 | Intermediary Bank Name |
intermediaryStreet | N/A | Alp-Num | -- | 1.1 | Intermediary Bank Street |
intermediaryCity | N/A | Alp-Num | -- | 1.1 | Intermediary Bank City |
intermediaryState | 2 / 3 | Alp | -- | 1.1 | Intermediary Bank State two - three letters state / province / county code (ISO 3166-2) |
intermediaryCountry | 2 | Alp | -- | 1.1 | Intermediary Bank Country two letters country code (ISO Char 2 Code) |
intermediaryPostalCode | N/A | Alp-Num | -- | 1.1 | Intermediary Bank Postal Code |
intermediarySwift | N/A | Alp-Num | -- | 1.1 | Intermediary Bank SWIFT Code |
intermediaryCodeBank | N/A | Alp-Num | -- | 1.1 | Intermediary Bank Code |
intermediaryFurtherAccount | N/A | Alp-Num | -- | 1.1 | Intermediary Further Account |
intermediaryBank | N/A | Alp-Num | -- | 1.1 | Intermediary Bank |
key | N/A | Alp-Num | Yes | 1.1 | MD5(sharedSecret + firstName + lastName + companyName + phone + addressId + bankName + bankSwiftCode + bankStreet + bankCity + bankState + bankCountry + bankPostalCode + bankAccountNumber + currency + bankRoutingCode + bankAccountType + accountType + intermediaryName + intermediaryStreet + intermediaryCity + intermediaryState + intermediaryCountry + intermediaryPostalCode + intermediarySwift + intermediaryCodeBank + intermediaryFurtherAccount + intermediaryBank ) |
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.1 | The response code; 00 = Success; |
ResponseDescription | N/A | Alp-Num | Yes | 1.1 | Human readable response |
Fee | N/A | Real | Yes | 1.1 | Fee for the current transaction |
TransactionId | N/A | Num | Yes | 1.1 | The transaction ID if successfully, otherwise not specified |
Request Sample:
https://secure.paxum.com/payment/api/paymentAPI.php POST method=addBankAccount&fromEmail=payee%40domain.com&firstName=firstName&lastName=lastName&companyName=&phone=1234567890&address=str&city=city&country=US&state=NY&postalCode=123456&bankName=Test&bankSwiftCode=api&bankStreet=str&bankCity=New+York&bankCountry=US&bankState=NY&bankPostalCode=123456&bankAccountNumber=123456789456¤cy=USD&bankRoutingCode=1234&accountType=1&bankAccountType=1&intermediaryName=&intermediaryStreet=&intermediaryCountry=&intermediaryState=&intermediarySwift=&intermediaryCodeBank=&intermediaryFurtherAccount=&intermediaryBank=&key=880617066b6ab9410c7d46418ade80f3
Response Sample
<?xml version="1.0"?> <Response> <Environment>PRODUCTION</Environment> <Method>addBankAccount</Method> <ResponseCode>00</ResponseCode> <ResponseDescription>Approved or Completed Successfully</ResponseDescription > <Fee>0.00</Fee> <TransactionId>23646236</TransactionId> </Response>
Working Sample(s):
addBankAccount.php