You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-24Lines changed: 19 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,34 +1,30 @@
1
-
#CyberSource PHP Client
2
-
1
+
# CyberSource PHP Client
3
2
This is the PHP client for the [CyberSource SOAP Toolkit API](http://www.cybersource.com/developers/getting_started/integration_methods/soap_toolkit_api).
The cybersource/sdk-php is available at [Packagist](https://packagist.org/packages/cybersource/sdk-php).
10
8
If you want to install SDK from Packagist,add the following dependency to your application's 'composer.json'.
11
-
12
-
"require": {
13
-
"cybersource/sdk-php": "*"
14
-
},
15
-
16
-
##Prerequisites
9
+
```json
10
+
"require": {
11
+
"cybersource/sdk-php": "*"
12
+
},
13
+
```
14
+
##Prerequisites
17
15
18
16
- PHP 5.3 or above
19
17
-[curl](http://php.net/manual/en/book.curl.php), [openssl](http://php.net/manual/en/book.openssl.php), [soap](http://php.net/manual/en/book.soap.php) extensions must be enabled
20
18
- A CyberSource account. You can create an evaluation account [here](http://www.cybersource.com/register/).
21
19
- A CyberSource transaction key. You will need to set your merchant ID and transaction key in the ````cybs.ini```` file in ````lib/conf````. Instructions on obtaining a transaction key can be found [here](http://www.cybersource.com/developers/integration_methods/simple_order_and_soap_toolkit_api/soap_api/html/wwhelp/wwhimpl/js/html/wwhelp.htm#href=Intro.04.3.html).
22
20
23
-
24
-
##Installation
25
-
21
+
## Installation
26
22
You can install the client either via [Composer](https://getcomposer.org/) or manually. Before installing, make sure to configure the merchant ID, transaction key, and the appropriate WSDL file URL in ````cybs.ini````. By default, the WSDL file for the client is for API version 1.120 (the latest when this package was updated). Available WSDL file URLs can be browsed at the following locations:
You'll first need to make sure you have Composer installed. You can follow the instructions on the [official web site](https://getcomposer.org/download/). Once Composer is installed, you can enter the project root and run:
33
29
```
34
30
composer.phar install
@@ -39,18 +35,17 @@ Then, to use the client, you'll need to include the Composer-generated autoload
The PHP client will generate the request message headers for you, and will contain the methods specified by the WSDL file.
52
47
53
-
###Creating a simple request
48
+
###Creating a simple request
54
49
The main method you'll use is ````runTransaction()````. To run a transaction, you'll first need to construct a client to generate a request object, which you can populate with the necessary fields (see [documentation](http://www.cybersource.com/developers/integration_methods/simple_order_and_soap_toolkit_api/soap_api/html/wwhelp/wwhimpl/js/html/wwhelp.htm#href=Intro.04.4.html) for sample requests). The object will be converted into XML, so the properties of the object will need to correspond to the correct XML format.
55
50
56
51
```php
@@ -68,7 +63,7 @@ $request->card = $card;
68
63
$reply = $client->runTransaction($request);
69
64
```
70
65
71
-
###Creating a request from XML
66
+
###Creating a request from XML
72
67
You can create a request from XML either in a file or from an XML string. The XML request format is described in the **Using XML** section [here](http://apps.cybersource.com/library/documentation/dev_guides/Simple_Order_API_Clients/Client_SDK_SO_API.pdf). Here's how to run a transaction from an XML file:
73
68
74
69
```php
@@ -86,7 +81,7 @@ $client = new CybsSoapClient();
86
81
$client->runTransactionFromXml($xml);
87
82
```
88
83
89
-
###Using name-value pairs
84
+
###Using name-value pairs
90
85
In order to run transactions using name-value pairs, make sure to set the value for the WSDL for the NVP transaction processor in ````cybs.ini````. Then use the ````CybsNameValuePairClient```` as so:
After configuring your merchant ID and transaction key in ````cybs.ini````, the samples in the ````samples```` directory can be run from the project root. For example:
104
99
105
100
```
@@ -108,7 +103,7 @@ php samples/Sale.php
108
103
109
104
The samples will output the response object for each request if successful. Note that the samples contain test data and should not be run in a live environment.
110
105
111
-
##Tests
106
+
##Tests
112
107
113
108
In order to run tests, you'll need [PHPUnit](https://phpunit.de). You'll also need to use [Composer](https://getcomposer.org/) for autoloading. If you used Composer to install the client, this should already be set up. Otherwise, to use Composer for autoloading only, from the project root run
114
109
```
@@ -117,7 +112,7 @@ composer.phar dump-autoload
117
112
118
113
If you installed PHPUnit with Composer, run the tests from the project root with the command ````vendor/bin/phpunit````.
119
114
120
-
##Documentation
115
+
##Documentation
121
116
122
117
For more information about CyberSource services, see <http://www.cybersource.com/developers/documentation>
0 commit comments