
Variant 1:
| Field Name | Len | Type | Req | Ver | Comments |
|---|---|---|---|---|---|
| method | N/A | Alp-Num | Yes | 1.0 | massTransferFundsWire |
| fromEmail | N/A | Alp-Num | Yes | 1.0 | The email associated with the account from which the amount is deducted |
| data | N/A | File | Yes | 1.0 | csv file (see format sample in mass_wire_transfer_sample_file.csv) |
| key | N/A | Alp-Num | Yes | 1.0 | MD5(sharedSecret) |
Variant 2:
| Field Name | Len | Type | Req | Ver | Comments |
|---|---|---|---|---|---|
| method | N/A | Alp-Num | Yes | 1.0 | massTransferFundsWire |
| fromEmail | N/A | Alp-Num | Yes | 1.0 | The email associated with the account from which the amount is deducted |
| data_inline | N/A | Alp-Num | Yes | 1.0 | 2511.USD.CHQ.000001,Madeleine Daniels,93 Thornton St,HURST GREEN,Angus,RH8 5TF,GB,1954.55,USD,GB24BKEN10000010000000,BANK OF ENGLAND,Threadneedle Street,London,Leeds,EC2R 8AH,GB,,BKENGB2L,commission,personal,1980-06-03,GB 2511.EUR.CHQ.000001,Molly Wright,45 Stone St,CRATHORNE,Kent,TS15 3AE,GB,1270.3,EUR,GB92BARC20005210000000,BARCLAYS BANK PLC,5 The North Colonnade Canary Wharf,London,0,E14 4PU,GB,,BARCGB22,commission,,, |
| key | N/A | Alp-Num | Yes | 1.0 | MD5(sharedSecret+data_inline) |
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 |
| Transactions / Transaction / Quantity | N/A | Num | Yes | 1.0 | Number of Transactions |
| Transactions / Transaction / Currency | N/A | Al-Num | Yes | 1.0 | Currency |
| Transactions / Transaction / Amount | N/A | Real | Yes | 1.0 | Amount |
| Transactions / Transaction / Fee | N/A | Real | Yes | 1.0 | Summary fee |
Request Sample:
<?php
$ch = curl_init();
curl_setopt_array( $ch, array(
CURLOPT_URL => "https://secure.paxum.com/payment/api/paymentAPI.php",
CURLOPT_RETURNTRANSFER => 1,
CURLOPT_POST => 1,
CURLOPT_POSTFIELDS => array(
"fromEmail" => "[email protected]",
"method" => "massTransferFundsWire",
"key" => md5( API_SECRET_KEY ),
"data" => "@path/to/file/mass_wire_2017-11-21.csv",// before php 5.5.0
"data" => new CURLFile( "path/to/file/mass_wire_2017-11-21.csv" ),// since php 5.5.0
),
) );
$result = curl_exec( $ch );
Response Sample:
<?xml version="1.0"?>
<Response>
<Environment>PRODUCTION</Environment>
<Method>massTransferFundsWire</Method>
<ResponseCode>00</ResponseCode>
<ResponseDescription>Approved or Completed Successfully</ResponseDescription>
<Transactions>
<Transaction>
<Quantity>1</Quantity>
<Currency>USD</Currency>
<Amount>15.50</Amount>
<Fee>4.50</Fee>
</Transaction>
<Transaction>
<Quantity>2</Quantity>
<Currency>EUR</Currency>
<Amount>33.50</Amount>
<Fee>7.50</Fee>
</Transaction>
...
</Transactions>
</Response>
Working Sample(s):
massTransferFundsWire.php