|
The AL-Desk Web Portal provides support for secure on line credit card processing allowing Credit card transactions to be fully integrated with AL-Desk Reporting and batch functions. An AL-Desk Credit card Server is required to support this API call. The als_credit_card_server_available.cgi can be used to check the availability of a Credit Card server.
This method is only supported via SSL so that user credit card information is never sent via an un-encrypted channel.
As is normal for all Put calls a valid webusercode is required. A Valid client number is required that references a client that has the required information including name, address, city, state and zip code as well as an email address. You can use als_get_client.cgi with the ccinfocheck parameter in order to test whether client information is valid for a credit card.
This call can also be combined with the call to write multiple vouchers, als_insert_voucher_payment.cgi so that multiple vouchers can be paid for with one credit card transaction.
Inputs
Parameter
|
Description
|
Required
|
Example
|
Data Type
|
webusercode
|
Code from WiUsers required for insert access
|
Required
|
webusercode=5
|
Integer
|
client
|
code of the client usually from a newly inserted client via als_insert_client.cgi
You can use als_get_client.cgi with the ccinfocheck param in order to test whether client information is valid for a credit card
|
Required
|
client=104437
|
Integer
|
amount
|
amount of the payment
|
Required
|
amount=100.47
|
Currency
|
ccexp
|
Credit Card Expiration Date in the format of MM/YY
|
Required
|
ccexp=0907
|
String
|
ccnumber
|
Credit Card Number
|
Required
|
ccnumber=12234566783
|
String
|
cccid
|
Information from the back of the card as Card Verification Value
|
Required
|
cid=222
|
String
|
ccname
|
Name on the Credit Card if different than the name used in the als_insert_client.cgi call. By default the client name will be fetched using the client:integer parameter.
must be formatted in the format of
lastname,firstname
|
Optional
|
ccname=smith, john
|
String
|
CardPresent
|
If the credit card is present. Default is false. only provided for use if needed in in non-internet transactions
|
Optional
default is false
|
cardpresent=false
|
Boolean
|
VerifyCardOnly
|
verifies the card only without posting the transaction
|
Optional
|
verifycardonly=false
|
Boolean
|
ManualAuthorization
|
|
|
|
|
ManualApprovalCode
|
|
|
|
|
AuthorizeOnly
|
|
|
|
|
CardSwiped
|
If the credit card is present. Default is false. only provided for use if needed in in non-internet transactions
|
Optional
|
cardswiped=false
|
Boolean
|
UseCID
|
Uses the extra information on the back of the card for verfification.
Default is TRUE to require this authorization
|
Optional
|
usecid=true
|
Boolean
|
ControlNO
|
whenever a payment is posted to AL-Desk a Control Number is created. To process a credit card a control number is required. When used with als_insert_voucher_payment.cgi the control number is created internally and used for the credit card authorization.
|
Required
|
|
|
NeedAVS
|
If true will use Address Verification
default is True
|
Optional
|
needavis=true
|
Boolean
|
VerifyCardOnly
|
|
Optional
|
VerifyCardOnly=true
|
Boolean
|
Credit
|
If true will issue a credit
|
Optional
|
credit=true
|
Boolean
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Outputs
Parameter
|
Description
|
Required
|
Example
|
Data Type
|
ResponseCode
|
|
|
|
String
|
Responsetext
|
|
|
|
String
|
ApprovalCode
|
|
|
|
String
|
PostedReference
|
|
|
|
String
|
|