Library that abstracts Authorize.Net's JSON APIs.
- PHP 7.2+ (Support for PHP 7.2.0 - 8.*)
- cURL PHP Extension
- JSON PHP Extension
- An Authorize.Net account
Support for PHP versions less than 7.2 has been removed from the master branch. There is a PHP 5.6 compatible branch available for development and releases for 5.6 may continue to be made as long as it is feasible to do so.
Simply add a dependency on stymiee/authnetjson to your project's composer.json file if you use Composer
to manage the dependencies of your project.
Here is a minimal example of a composer.json file that just defines a dependency on AuthnetJSON:
{
"require": {
"stymiee/authnetjson": "~4.1"
}
}
Using this library usually consists of three steps:
- Initiate the library with the login credentials for your Authorize.Net account
- Make the API call passing any required parameters as an array
- Check for the results and use them appropriately
NOTE: If you are viewing any of the examples in a browser you will need to fill your Authorize.Net credentials in config.inc.php before usage
Simple usage:
$request = AuthnetApiFactory::getJsonApiHandler(AUTHNET_LOGIN, AUTHNET_TRANSKEY);
$response = $request->getTransactionDetailsRequest([
'transId' => '2162566217'
]);
if ($response->isSuccessful()) {
echo $response->transaction->transactionStatus;
}The format of the array to be passed during the API call follows the structure outlined in Authorize.Net's Integration Guide.
Authorize.Net provides a development environment for developers to test their integration against. To use this endpoint
(as opposed to their production endpoint) set the optional third parameter of AuthnetApiFactory::getJsonApiHandler() to be 1 or use the built in class constant AuthnetApiFactory::USE_DEVELOPMENT_SERVER:
$json = AuthnetApiFactory::getJsonApiHandler(AUTHNET_LOGIN, AUTHNET_TRANSKEY,
AuthnetApiFactory::USE_DEVELOPMENT_SERVER);
To help make how this library is used easier to understand example API calls are provided in the example directory.
Examples for all of the current APIs calls are represented. You may need to make adjustments to get some to work as
they may be dependent on valid values created from other API calls (i.e. a void will not work without a valid
transaction ID).
$request = AuthnetApiFactory::getJsonApiHandler(AUTHNET_LOGIN, AUTHNET_TRANSKEY);
$response = $request->createTransactionRequest([
'refId' => rand(1000000, 100000000),
'transactionRequest' => [
'transactionType' => 'authCaptureTransaction',
'amount' => 5,
'payment' => [
'creditCard' => [
'cardNumber' => '4111111111111111',
'expirationDate' => '122026',
'cardCode' => '999',
]
]
]
]);
if ($response->isSuccessful()) {
echo $response->transactionResponse->authCode;
}$request = AuthnetApiFactory::getJsonApiHandler(AUTHNET_LOGIN, AUTHNET_TRANSKEY);
$response = $request->createTransactionRequest([
'refId' => rand(1000000, 100000000),
'transactionRequest' => [
'transactionType' => 'authCaptureTransaction',
'amount' => 5,
'payment' => [
'creditCard' => [
'cardNumber' => '4111111111111111',
'expirationDate' => '122026',
'cardCode' => '999',
],
],
'order' => [
'invoiceNumber' => '1324567890',
'description' => 'this is a test transaction',
],
'lineItems' => [
'lineItem' => [
0 => [
'itemId' => '1',
'name' => 'vase',
'description' => 'Cannes logo',
'quantity' => '18',
'unitPrice' => '45.00'
],
1 => [
'itemId' => '2',
'name' => 'desk',
'description' => 'Big Desk',
'quantity' => '10',
'unitPrice' => '85.00'
]
]
],
'tax' => [
'amount' => '4.26',
'name' => 'level2 tax name',
'description' => 'level2 tax',
],
'duty' => [
'amount' => '8.55',
'name' => 'duty name',
'description' => 'duty description',
],
'shipping' => [
'amount' => '4.26',
'name' => 'level2 tax name',
'description' => 'level2 tax',
],
'poNumber' => '456654',
'customer' => [
'id' => '18',
'email' => '[email protected]',
],
'billTo' => [
'firstName' => 'Ellen',
'lastName' => 'Johnson',
'company' => 'Souveniropolis',
'address' => '14 Main Street',
'city' => 'Pecan Springs',
'state' => 'TX',
'zip' => '44628',
'country' => 'USA',
],
'shipTo' => [
'firstName' => 'China',
'lastName' => 'Bayles',
'company' => 'Thyme for Tea',
'address' => '12 Main Street',
'city' => 'Pecan Springs',
'state' => 'TX',
'zip' => '44628',
'country' => 'USA',
],
'customerIP' => '192.168.1.1',
'transactionSettings' => [
'setting' => [
0 => [
'settingName' =>'allowPartialAuth',
'settingValue' => 'false'
],
1 => [
'settingName' => 'duplicateWindow',
'settingValue' => '0'
],
2 => [
'settingName' => 'emailCustomer',
'settingValue' => 'false'
],
3 => [
'settingName' => 'recurringBilling',
'settingValue' => 'false'
],
4 => [
'settingName' => 'testRequest',
'settingValue' => 'false'
]
]
],
'userFields' => [
'userField' => [
0 => [
'name' => 'MerchantDefinedFieldName1',
'value' => 'MerchantDefinedFieldValue1',
],
1 => [
'name' => 'favorite_color',
'value' => 'blue',
],
],
],
],
]);
if ($response->isSuccessful()) {
echo $response->transactionResponse->authCode;
}$request = AuthnetApiFactory::getJsonApiHandler(AUTHNET_LOGIN, AUTHNET_TRANSKEY);
$response = $request->createCustomerProfileRequest([
'profile' => [
'merchantCustomerId' => '12345',
'email' => '[email protected]',
'paymentProfiles' => [
'billTo' => [
'firstName' => 'John',
'lastName' => 'Smith',
'address' => '123 Main Street',
'city' => 'Townsville',
'state' => 'NJ',
'zip' => '12345',
'phoneNumber' => '800-555-1234'
],
'payment' => [
'creditCard' => [
'cardNumber' => '4111111111111111',
'expirationDate' => '2026-08',
],
],
],
'shipToList' => [
'firstName' => 'John',
'lastName' => 'Smith',
'address' => '123 Main Street',
'city' => 'Townsville',
'state' => 'NJ',
'zip' => '12345',
'phoneNumber' => '800-555-1234'
],
],
'validationMode' => 'liveMode'
]);
if ($response->isSuccessful()) {
echo $response->customerProfileId;
}$request = AuthnetApiFactory::getJsonApiHandler(AUTHNET_LOGIN, AUTHNET_TRANSKEY);
$response = $request->ARBCreateSubscriptionRequest([
'refId' => 'Sample',
'subscription' => [
'name' => 'Sample subscription',
'paymentSchedule' => [
'interval' => [
'length' => '1',
'unit' => 'months'
],
'startDate' => '2020-04-18',
'totalOccurrences' => '12',
'trialOccurrences' => '1'
],
'amount' => '10.29',
'trialAmount' => '0.00',
'payment' => [
'creditCard' => [
'cardNumber' => '4111111111111111',
'expirationDate' => '2016-08'
]
],
'billTo' => [
'firstName' => 'John',
'lastName' => 'Smith'
]
]
]);
if ($response->isSuccessful()) {
echo $response->subscriptionId;
}$request = AuthnetApiFactory::getJsonApiHandler(AUTHNET_LOGIN, AUTHNET_TRANSKEY);
$response = $request->getSettledBatchListRequest([
'includeStatistics' => 'true',
'firstSettlementDate' => '2020-01-01T08:15:30',
'lastSettlementDate' => '2020-01-30T08:15:30',
]);
if ($response->isSuccessful()) {
foreach ($response->batchList as $batch) {
echo $batch->batchId;
}
}Some CIM API calls process an AUTH_CAPTURE transaction and return data similar to AIM AUTH_CAPTURE transactions. To access
this information you can call AuthnetJsonResponse::getTransactionResponseField() using the field name or field number.
For example, if you are looking for the transaction ID you can use:
$response->getTransactionResponseField('TransactionID');or
$response->getTransactionResponseField(7);Field name and number can be found in the Authorize.Net AIM Guide. Note
that the field name has all spaces removed so TransactionID becomes TransactionID.
$response = $request->createWebhooks([
"net.authorize.customer.subscription.expiring",
"net.authorize.customer.subscription.suspended",
"net.authorize.payment.authcapture.created",
"net.authorize.payment.authorization.created",
"net.authorize.payment.capture.created",
"net.authorize.payment.fraud.approved",
"net.authorize.payment.fraud.declined",
"net.authorize.payment.fraud.held",
"net.authorize.payment.priorAuthCapture.created",
"net.authorize.payment.refund.created",
"net.authorize.payment.void.created"
], 'http://www.example.com:55950/api/webhooks', 'active');$payload = file_get_contents("php://input");
$webhook = new AuthnetWebhook(AUTHNET_SIGNATURE, $payload);
if ($webhook->isValid()) {
// Access notifcation values
// echo $webhook->eventType;
}If apache_request_headers()/getallheaders() are not available to you, you can will need to get the HTTP request
headers and pass them as the third parameter to AuthnetWebhook().
$headers = yourGetHeadersFunction();
$payload = file_get_contents("php://input");
$webhook = new AuthnetWebhook(AUTHNET_SIGNATURE, $payload, $headers);
if ($webhook->isValid()) {
// Access notifcation values
// echo $webhook->eventType;
}To see examples of an Accept.js powered self hosted payment form, an Authorize.Net hosted payment form, and a hosted customer profile page, visit the Accept.js examples directory.
To assist with debugging the __toString() method has been overridden to output important elements pertaining to the
usage of this library. Simple echo your AuthnetJSON object to see:
- The API Login ID used
- The API transaction Key used
- The API endpoint the request was sent to
- The request JSON
- The response JSON
$request = AuthnetApiFactory::getJsonApiHandler(AUTHNET_LOGIN, AUTHNET_TRANSKEY);
$response = $request->getUnsettledTransactionListRequest();
echo $request, $response;If you require assistance using this library start by viewing the HELP.md file included in this package. It includes common problems and their solutions.
If you need additional assistance, I can be found at Stack Overflow. Be sure when you ask a question pertaining to the usage of this class be sure to tag your question with the PHP and Authorize.Net tags. Make sure you follow their guide for asking a good question as poorly asked questions will be closed and I will not be able to assist you.
Do not use Stack Overflow to report bugs. Bugs may be reported here.