Deposit to Card Number – Function 007
Function 007 API call will add or remove funds to a card. This call is also referred to as “Add Funds” or “Load funds” and similarly “Remove funds” or “Unload funds”. Remember to set the P5 flag correctly when adding or removing funds to the card. If fees are provided, this function will call AuthENGINAPI FUNC=030 Cardholder Fees. When Cardholder Fees is called, any fees that need currency conversion will have been converted to the Settlement currency.
| Inputs | Description | Required | Data Type |
|---|---|---|---|
| FunctionID | 007 | Y | |
| P1 | PAN OR ALT ID | Y | (16,19) numeric |
| P2 | Amount | Y | numeric |
| P3 | Reserved | N | |
| P4 | Transaction Type (0 = Credit, 1 = Debit) | Y | 0 or 1 |
| P5 | Currency Code (ISO 4217 – Alpha) | N* | (3) varchar |
| P6 | Settlement Amount | N | numeric |
| P7 | Settlement Currency Code (ISO 4217 – Alpha) | N* | (3) varchar |
| P8 | Transaction Description | Y | (0,30) varchar |
| P9 | Terminal Owner | N | (1,30) varchar |
| P10 | Terminal Location | N | (1,30) varchar |
| P11 | Terminal City | N | (1,13) varchar |
| P12 | Terminal State | N | (2) varchar |
| P13 | Terminal ID | N | (20) numeric Right justified zero padded |
| P14 | Country | N | (2) varchar |
| P15 | Transaction Flat Fee (debit only) | N | numeric |
| P16 | Fee Description | N | (1,30) varchar |
| direct Fee | Populate this fee and AE will apply it as an adjustment. Do not use currency conversion with this fee. – one-time fee applicable to this transaction | N | (0,6) Numeric |
| Outputs | Description | ||
| P1 | Error Code | Y | |
| P2 | Error Text | Y | |
| Symbol | Currency Conversion symbol | N | e.g.)AUDUSD |
| Rate | Exchange Rate used for transaction | N | |
| amount | Converted Rate of deposit | N |
Example: Card Deposit/Remove Request
https://api
m2fin.com:8443/AuthENGINAPI/AuthENGINAPI?CID=5&CUSR=myuseraccount&CPWD=passwordassignedtom
e&FUNC=007&MSGID=00001594011000282&P1= PAN OR ALT
ID&P2=1000&P3=&P4=0000&P5=usd&P6=0012&P7=usd&P8=initial
m2fin.com:8443/AuthENGINAPI/AuthENGINAPI?CID=5&CUSR=myuseraccount&CPWD=passwordassignedtom
e&FUNC=007&MSGID=00001594011000282&P1= PAN OR ALT
ID&P2=1000&P3=&P4=0000&P5=usd&P6=0012&P7=usd&P8=initial
Examples: Card Deposit/Remove Response
* The initial API user configuration normally designates a ‘Base Currency’ and there are several scenarios that can occur if these fields are populated with the currency of the transaction and settlement:
- If the base currency is defined and the transaction is the same currency, these fields are not required.
- If the base currency is not defined and the fields are not populated, USD is assumed. If other than USD, then the fields become required.
- If the base currency is defined and the transaction is the same currency as the base currency, but the fields are defined, currency conversion will occur assuming base currency is USD currency.
*Difference between P15 – Flat Fee and Direct Fee